Merge pull request #56 from DeterminateSystems/stable-cli-in-manual

Mark the nix CLI as *the* interface in the manual, deprecate nix-*

doc/manual/book.toml.in

@@ -1,5 +1,5 @@
 [book]
-title = "Determinate Nix Reference Manual"
+title = "Determinate Nix @version@ Reference Manual"
 src = "source"
 
 [output.html]

doc/manual/meson.build

@@ -4,6 +4,8 @@ project('nix-manual',
   license : 'LGPL-2.1-or-later',
 )
 
+fs = import('fs')
+
 nix = find_program('nix', native : true)
 
 mdbook = find_program('mdbook', native : true)
@@ -83,6 +85,7 @@ manual = custom_target(
     '''
         @0@ @INPUT0@ @CURRENT_SOURCE_DIR@ > @DEPFILE@
         @0@ @INPUT1@ summary @2@ < @CURRENT_SOURCE_DIR@/source/SUMMARY.md.in > @2@/source/SUMMARY.md
+        sed -e 's|@version@|@3@|g' < @INPUT2@ > @2@/book.toml
         rsync -r --include='*.md' @CURRENT_SOURCE_DIR@/ @2@/
         (cd @2@; RUST_LOG=warn @1@ build -d @2@ 3>&2 2>&1 1>&3) | { grep -Fv "because fragment resolution isn't implemented" || :; } 3>&2 2>&1 1>&3
         rm -rf @2@/manual
@@ -92,12 +95,13 @@ manual = custom_target(
       python.full_path(),
       mdbook.full_path(),
       meson.current_build_dir(),
+      fs.read('../../.version-determinate').strip(),
     ),
   ],
   input : [
     generate_manual_deps,
     'substitute.py',
-    'book.toml',
+    'book.toml.in',
     'anchors.jq',
     'custom.css',
     nix3_cli_files,

doc/manual/package.nix

@@ -30,6 +30,7 @@ mkMesonDerivation (finalAttrs: {
     fileset.difference
       (fileset.unions [
         ../../.version
+        ../../.version-determinate
         # Too many different types of files to filter for now
         ../../doc/manual
         ./.

doc/manual/source/SUMMARY.md.in

@@ -54,7 +54,9 @@
 - [Command Reference](command-ref/index.md)
   - [Common Options](command-ref/opt-common.md)
   - [Common Environment Variables](command-ref/env-common.md)
-  - [Main Commands](command-ref/main-commands.md)
+  - [Subcommands](command-ref/subcommands.md)
+{{#include ./command-ref/new-cli/SUMMARY.md}}
+  - [Deprecated Commands](command-ref/main-commands.md)
     - [nix-build](command-ref/nix-build.md)
     - [nix-shell](command-ref/nix-shell.md)
     - [nix-store](command-ref/nix-store.md)
@@ -98,8 +100,6 @@
     - [nix-hash](command-ref/nix-hash.md)
     - [nix-instantiate](command-ref/nix-instantiate.md)
     - [nix-prefetch-url](command-ref/nix-prefetch-url.md)
-  - [Experimental Commands](command-ref/experimental-commands.md)
-{{#include ./command-ref/new-cli/SUMMARY.md}}
   - [Files](command-ref/files.md)
     - [nix.conf](command-ref/conf-file.md)
     - [Profiles](command-ref/files/profiles.md)

doc/manual/source/command-ref/experimental-commands.md

@@ -1,8 +0,0 @@
-# Experimental Commands
-
-This section lists [experimental commands](@docroot@/development/experimental-features.md#xp-feature-nix-command).
-
-> **Warning**
->
-> These commands may be removed in the future, or their syntax may
-> change in incompatible ways.

doc/manual/source/command-ref/subcommands.md

@@ -0,0 +1,3 @@
+# Subcommands
+
+This section lists all the subcommands of the `nix` CLI.

src/libstore/.version-determinate

@@ -1 +0,0 @@
-../../.version-determinate

src/libstore/meson.build

@@ -22,7 +22,7 @@ configdata = configuration_data()
 # TODO rename, because it will conflict with downstream projects
 configdata.set_quoted('PACKAGE_VERSION', meson.project_version())
 
-configdata.set_quoted('DETERMINATE_NIX_VERSION', fs.read('.version-determinate').strip())
+configdata.set_quoted('DETERMINATE_NIX_VERSION', fs.read('../../.version-determinate').strip())
 
 configdata.set_quoted('SYSTEM', host_machine.cpu_family() + '-' + host_machine.system())
 

src/libstore/package.nix

@@ -39,7 +39,6 @@ mkMesonLibrary (finalAttrs: {
     ../../.version
     ./.version
     ../../.version-determinate
-    ./.version-determinate
     ./meson.build
     ./meson.options
     ./linux/meson.build