things TODO

src/libstore/globals.hh

@@ -185,6 +185,7 @@ public:
           command line switch and defaults to `1`. The value `0` means that
           the builder should use all available CPU cores in the system.
         )",
+        // TODO: determine if this should `auto` as getDefaultCores uses getMaxCPU then falls back on getMaxThreads
         {"build-cores"}, "0"};
 
     /**
@@ -296,6 +297,7 @@ public:
           default is `true`.
         )"};
 
+    // TODO: should this setting use defaultText
     Setting<bool> useSQLiteWAL{this, !isWSL1(), "use-sqlite-wal",
         "Whether SQLite should use WAL mode."};
 
@@ -344,6 +346,7 @@ public:
           `NIX_REMOTE` is `daemon`). Obviously, this should not be used
           with a nix daemon accessible to untrusted clients.
         )",
+        // TODO: check this is a good way to improve the documentation
         {}, "`nixbld` when running as root, *empty* otherwise"};
 
     Setting<bool> autoAllocateUids{this, false, "auto-allocate-uids",
@@ -874,6 +877,7 @@ public:
         )"};
 
     Setting<std::string> netrcFile{
+        // TODO: figure out if updating the description worked well
         this, fmt("%s/%s", nixConfDir, "netrc"), "netrc-file",
         R"(
           If set to an absolute path to a `netrc` file, Nix will use the HTTP

src/libutil/abstract-setting-to-json.hh

@@ -12,6 +12,7 @@ std::map<std::string, nlohmann::json> BaseSetting<T>::toJSONObject()
     auto obj = AbstractSetting::toJSONObject();
     obj.emplace("value", value);
     obj.emplace("defaultValue", defaultValue);
+    // TODO: consider not adding this value if defaultText == std::nullopt
     obj.emplace("defaultText", defaultText);
     return obj;
 }