Get settings info out of headers, out of libutil

doc/manual/generate-settings.nix

@@ -19,19 +19,32 @@ in
   prefix,
   inlineHTML ? true,
 }:
-settingsInfo:
 
 let
 
   showSetting =
     prefix: setting:
     {
       description,
-      documentDefault,
-      defaultValue,
-      aliases,
-      value,
+
       experimentalFeature,
+
+      # Whether we document the default, because it is machine agostic,
+      # or don't because because it is machine-specific.
+      documentDefault ? true,
+
+      # The default value is JSON for new-style config, rather than then
+      # a string or boolean, for old-style config.
+      isJson ? false,
+
+      defaultValue ? null,
+
+      subSettings ? null,
+
+      aliases ? [ ],
+
+      # The current value for this setting. Purposefully unused.
+      value ? null,
     }:
     let
       result = squash ''
@@ -50,7 +63,7 @@ let
 
         ${description}
 
-        **Default:** ${showDefault documentDefault defaultValue}
+        ${showDefaultOrSubSettings}
 
         ${showAliases aliases}
       '';
@@ -72,9 +85,24 @@ let
         > ```
       '';
 
+      showDefaultOrSubSettings =
+        if !isAttrs subSettings then
+          # No subsettings, instead single setting. Show the default value.
+          ''
+            **Default:** ${showDefault}
+          ''
+        else
+          # Indent the nested sub-settings, and append the outer setting name onto the prefix
+          indent "  " ''
+            **Nullable sub-settings**: ${if subSettings.nullable then "true" else "false"}
+            ${builtins.trace prefix (showSettings "${prefix}-${setting}" subSettings.map)}
+          '';
+
       showDefault =
-        documentDefault: defaultValue:
         if documentDefault then
+          if isJson then
+            "`${builtins.toJSON defaultValue}`"
+          else
           # a StringMap value type is specified as a string, but
           # this shows the value type. The empty stringmap is `null` in
           # JSON, but that converts to `{ }` here.
@@ -95,5 +123,7 @@ let
     in
     result;
 
+  showSettings =
+    prefix: settingsInfo: concatStrings (attrValues (mapAttrs (showSetting prefix) settingsInfo));
 in
-concatStrings (attrValues (mapAttrs (showSetting prefix) settingsInfo))
+showSettings prefix

doc/manual/source/release-notes/rl-2.28.md

@@ -46,7 +46,7 @@ This completes the infrastructure overhaul for the [RFC 132](https://github.com/
   @@ @@
   -#include "config.hh"
   +// Additionally renamed to distinguish from components' config headers.
-  +#include "nix/util/configuration.hh"
+  +#include "nix/main/configuration.hh"
   @@ @@
   -#if HAVE_ACL_SUPPORT
   +#if NIX_SUPPORT_ACL

meson.build

@@ -26,8 +26,8 @@ subproject('nix')
 
 # Docs
 if get_option('doc-gen')
-  subproject('internal-api-docs')
-  subproject('external-api-docs')
+  #subproject('internal-api-docs')
+  #subproject('external-api-docs')
   if meson.can_run_host_binaries()
     subproject('nix-manual')
   endif

src/libcmd/common-eval-args.cc

@@ -2,7 +2,7 @@
 #include "nix/expr/eval-settings.hh"
 #include "nix/cmd/common-eval-args.hh"
 #include "nix/main/shared.hh"
-#include "nix/util/config-global.hh"
+#include "nix/main/config-global.hh"
 #include "nix/store/filetransfer.hh"
 #include "nix/expr/eval.hh"
 #include "nix/fetchers/fetchers.hh"

src/libcmd/include/nix/cmd/command.hh

@@ -2,7 +2,7 @@
 ///@file
 
 #include "nix/cmd/installable-value.hh"
-#include "nix/util/args.hh"
+#include "nix/main/args.hh"
 #include "nix/cmd/common-eval-args.hh"
 #include "nix/store/path.hh"
 #include "nix/flake/lockfile.hh"

src/libcmd/include/nix/cmd/common-eval-args.hh

@@ -1,7 +1,7 @@
 #pragma once
 ///@file
 
-#include "nix/util/args.hh"
+#include "nix/main/args.hh"
 #include "nix/util/canon-path.hh"
 #include "nix/main/common-args.hh"
 #include "nix/expr/search-path.hh"

src/libcmd/include/nix/cmd/compatibility-settings.hh

@@ -1,5 +1,5 @@
 #pragma once
-#include "nix/util/configuration.hh"
+#include "nix/main/configuration.hh"
 
 namespace nix {
 struct CompatibilitySettings : public Config

src/libcmd/include/nix/cmd/misc-store-flags.hh

@@ -1,4 +1,4 @@
-#include "nix/util/args.hh"
+#include "nix/main/args.hh"
 #include "nix/store/content-address.hh"
 
 namespace nix::flag {

src/libexpr-c/nix_api_external.cc

@@ -1,5 +1,5 @@
 #include "nix/expr/attr-set.hh"
-#include "nix/util/configuration.hh"
+#include "nix/main/configuration.hh"
 #include "nix/expr/eval.hh"
 #include "nix/store/globals.hh"
 #include "nix/expr/value.hh"

src/libexpr-c/nix_api_value.cc

@@ -1,5 +1,5 @@
 #include "nix/expr/attr-set.hh"
-#include "nix/util/configuration.hh"
+#include "nix/main/configuration.hh"
 #include "nix/expr/eval.hh"
 #include "nix/store/globals.hh"
 #include "nix/store/path.hh"

src/libexpr/eval-gc.cc

@@ -1,7 +1,7 @@
 #include "nix/util/error.hh"
 #include "nix/util/environment-variables.hh"
 #include "nix/expr/eval-settings.hh"
-#include "nix/util/config-global.hh"
+#include "nix/main/config-global.hh"
 #include "nix/util/serialise.hh"
 #include "nix/expr/eval-gc.hh"
 #include "nix/expr/value.hh"

src/libexpr/include/nix/expr/eval-settings.hh

@@ -2,7 +2,7 @@
 ///@file
 
 #include "nix/expr/eval-profiler-settings.hh"
-#include "nix/util/configuration.hh"
+#include "nix/main/configuration.hh"
 #include "nix/util/source-path.hh"
 
 namespace nix {

src/libexpr/include/nix/expr/eval.hh

@@ -8,7 +8,7 @@
 #include "nix/expr/value.hh"
 #include "nix/expr/nixexpr.hh"
 #include "nix/expr/symbol-table.hh"
-#include "nix/util/configuration.hh"
+#include "nix/main/configuration.hh"
 #include "nix/util/experimental-features.hh"
 #include "nix/util/position.hh"
 #include "nix/util/pos-table.hh"

src/libfetchers/include/nix/fetchers/fetch-settings.hh

@@ -2,7 +2,7 @@
 ///@file
 
 #include "nix/util/types.hh"
-#include "nix/util/configuration.hh"
+#include "nix/main/configuration.hh"
 #include "nix/util/ref.hh"
 #include "nix/util/sync.hh"
 

src/libflake/config.cc

@@ -14,7 +14,7 @@
 #include <format>
 
 #include "nix/util/users.hh"
-#include "nix/util/config-global.hh"
+#include "nix/main/config-global.hh"
 #include "nix/flake/settings.hh"
 #include "nix/flake/flake.hh"
 #include "nix/util/ansicolor.hh"

src/libflake/include/nix/flake/settings.hh

@@ -4,7 +4,7 @@
 #include <sys/types.h>
 #include <string>
 
-#include "nix/util/configuration.hh"
+#include "nix/main/configuration.hh"
 
 namespace nix {
 // Forward declarations

src/libutil/args.cc → src/libmain/args.cc

@@ -1,5 +1,5 @@
-#include "nix/util/args.hh"
-#include "nix/util/args/root.hh"
+#include "nix/main/args.hh"
+#include "nix/main/args/root.hh"
 #include "nix/util/hash.hh"
 #include "nix/util/environment-variables.hh"
 #include "nix/util/signals.hh"

src/libmain/common-args.cc

@@ -1,8 +1,8 @@
 #include <nlohmann/json.hpp>
 
 #include "nix/main/common-args.hh"
-#include "nix/util/args/root.hh"
-#include "nix/util/config-global.hh"
+#include "nix/main/args/root.hh"
+#include "nix/main/config-global.hh"
 #include "nix/store/globals.hh"
 #include "nix/util/logging.hh"
 #include "nix/main/loggers.hh"

src/libutil/config-global.cc → src/libmain/config-global.cc

@@ -1,4 +1,4 @@
-#include "nix/util/config-global.hh"
+#include "nix/main/config-global.hh"
 
 #include <nlohmann/json.hpp>
 

src/libmain/config-upstream.cc

@@ -0,0 +1,54 @@
+namespace nix {
+
+#include "nix/util/fs-sink.hh"
+#include "nix/util/logging.hh"
+
+struct LoggerSettings : Config
+{
+    Setting<bool> showTrace{
+        this,
+        false,
+        "show-trace",
+        R"(
+          Whether Nix should print out a stack trace in case of Nix
+          expression evaluation errors.
+        )"};
+    Setting<Path> jsonLogPath{
+        this,
+        "",
+        "json-log-path",
+        R"(
+          A file or unix socket to which JSON records of Nix's log output are
+          written, in the same format as `--log-format internal-json`
+          (without the `@nix ` prefixes on each line).
+          Concurrent writes to the same file by multiple Nix processes are not supported and
+          may result in interleaved or corrupted log records.
+        )"};
+};
+
+static GlobalConfig::Register r1(&restoreSinkSettings);
+
+struct RestoreSinkSettings : Config
+{
+    Setting<bool> preallocateContents{
+        this, false, "preallocate-contents", "Whether to preallocate files when writing objects with known size."};
+};
+
+static GlobalConfig::Register rLoggerSettings(&loggerSettings);
+
+struct ArchiveSettings : Config
+{
+    Setting<bool> useCaseHack{
+        this,
+#if __APPLE__
+        true,
+#else
+        false,
+#endif
+        "use-case-hack",
+        "Whether to enable a macOS-specific hack for dealing with file name case collisions."};
+};
+
+static GlobalConfig::Register rArchiveSettings(&archiveSettings);
+
+} // namespace nix

src/libutil/configuration.cc → src/libmain/configuration.cc

@@ -1,12 +1,12 @@
-#include "nix/util/configuration.hh"
-#include "nix/util/args.hh"
-#include "nix/util/abstract-setting-to-json.hh"
+#include "nix/main/configuration.hh"
+#include "nix/main/args.hh"
+#include "nix/main/abstract-setting-to-json.hh"
 #include "nix/util/environment-variables.hh"
 #include "nix/util/experimental-features.hh"
 #include "nix/util/util.hh"
 #include "nix/util/file-system.hh"
 
-#include "nix/util/config-impl.hh"
+#include "nix/main/config-impl.hh"
 
 #include <nlohmann/json.hpp>
 
@@ -494,27 +494,4 @@ void OptionalPathSetting::operator=(const std::optional<Path> & v)
     this->assign(v);
 }
 
-bool ExperimentalFeatureSettings::isEnabled(const ExperimentalFeature & feature) const
-{
-    auto & f = experimentalFeatures.get();
-    return std::find(f.begin(), f.end(), feature) != f.end();
-}
-
-void ExperimentalFeatureSettings::require(const ExperimentalFeature & feature, std::string reason) const
-{
-    if (!isEnabled(feature))
-        throw MissingExperimentalFeature(feature, std::move(reason));
-}
-
-bool ExperimentalFeatureSettings::isEnabled(const std::optional<ExperimentalFeature> & feature) const
-{
-    return !feature || isEnabled(*feature);
-}
-
-void ExperimentalFeatureSettings::require(const std::optional<ExperimentalFeature> & feature) const
-{
-    if (feature)
-        require(*feature);
-}
-
 } // namespace nix

src/libutil/include/nix/util/abstract-setting-to-json.hh → src/libmain/include/nix/main/abstract-setting-to-json.hh

@@ -2,7 +2,7 @@
 ///@file
 
 #include <nlohmann/json.hpp>
-#include "nix/util/configuration.hh"
+#include "nix/main/configuration.hh"
 #include "nix/util/json-utils.hh"
 
 namespace nix {

src/libutil/include/nix/util/args/root.hh → src/libmain/include/nix/main/args/root.hh

@@ -1,6 +1,6 @@
 #pragma once
 
-#include "nix/util/args.hh"
+#include "nix/main/args.hh"
 
 namespace nix {
 

src/libmain/include/nix/main/common-args.hh

@@ -1,7 +1,7 @@
 #pragma once
 ///@file
 
-#include "nix/util/args.hh"
+#include "nix/main/args.hh"
 #include "nix/util/repair-flag.hh"
 
 namespace nix {

src/libutil/include/nix/util/config-global.hh → src/libmain/include/nix/main/config-global.hh

@@ -1,7 +1,7 @@
 #pragma once
 ///@file
 
-#include "nix/util/configuration.hh"
+#include "nix/main/configuration.hh"
 
 namespace nix {
 

src/libutil/include/nix/util/config-impl.hh → src/libmain/include/nix/main/config-impl.hh

@@ -13,8 +13,8 @@
  */
 
 #include "nix/util/util.hh"
-#include "nix/util/configuration.hh"
-#include "nix/util/args.hh"
+#include "nix/main/configuration.hh"
+#include "nix/main/args.hh"
 #include "nix/util/logging.hh"
 
 namespace nix {