From bf2adb82b7f1fd702ffd8a16b1c3f14b068874c6 Mon Sep 17 00:00:00 2001 From: h7x4 Date: Sun, 16 Jun 2024 20:40:28 +0200 Subject: [PATCH] nixos/doc: move implementation notes for formats.libconfig to docs --- nixos/doc/manual/development/settings-options.section.md | 8 ++++++++ pkgs/pkgs-lib/formats/libconfig/default.nix | 8 -------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/nixos/doc/manual/development/settings-options.section.md b/nixos/doc/manual/development/settings-options.section.md index 19984a7e345c..48cc62bb424c 100644 --- a/nixos/doc/manual/development/settings-options.section.md +++ b/nixos/doc/manual/development/settings-options.section.md @@ -269,6 +269,14 @@ have a predefined type and string generator already declared under } ``` + `Implementation notes:` + + - Since libconfig does not allow setting names to start with an underscore, + this is used as a prefix for both special types and include directives. + + - The difference between 32bit and 64bit values became optional in libconfig + 1.5, so we assume 64bit values for all numbers. + `pkgs.formats.json` { } : A function taking an empty attribute set (for future extensibility) diff --git a/pkgs/pkgs-lib/formats/libconfig/default.nix b/pkgs/pkgs-lib/formats/libconfig/default.nix index 5687ab8c0057..e30c6c3c9300 100644 --- a/pkgs/pkgs-lib/formats/libconfig/default.nix +++ b/pkgs/pkgs-lib/formats/libconfig/default.nix @@ -3,14 +3,6 @@ }: let inherit (pkgs) buildPackages callPackage; - # Implementation notes: - # Libconfig spec: https://hyperrealm.github.io/libconfig/libconfig_manual.html - # - # Since libconfig does not allow setting names to start with an underscore, - # this is used as a prefix for both special types and include directives. - # - # The difference between 32bit and 64bit values became optional in libconfig - # 1.5, so we assume 64bit values for all numbers. libconfig-generator = buildPackages.rustPlatform.buildRustPackage { name = "libconfig-generator";