From 44d21f6ef9783bed8812d39ff7b1a28a4883f84b Mon Sep 17 00:00:00 2001
From: Valentin Gagarin <valentin.gagarin@tweag.io>
Date: Thu, 30 Nov 2023 20:36:50 +0100
Subject: [PATCH] keep generated documentation in a separate directory

- helps navigating the code as it highlights which files are generated
- makes it less error prone when working incrementally
  (although this should be just fixed by building out of tree)
---
 .gitignore                                    |  2 +-
 .../manual/src/store/types/index.md.in        |  4 ----
 src/nix/local.mk                              | 19 ++++++++++++++++---
 src/nix/main.cc                               |  2 +-
 src/nix/profile.md                            |  2 +-
 5 files changed, 19 insertions(+), 10 deletions(-)
 rename src/nix/help-stores.md => doc/manual/src/store/types/index.md.in (99%)

diff --git a/.gitignore b/.gitignore
index 13a4dfb75..bcf9c4a01 100644
--- a/.gitignore
+++ b/.gitignore
@@ -54,7 +54,7 @@ perl/Makefile.config
 
 /src/nix/nix
 
-/src/nix/doc
+/src/nix/generated-doc
 
 # /src/nix-env/
 /src/nix-env/nix-env
diff --git a/src/nix/help-stores.md b/doc/manual/src/store/types/index.md.in
similarity index 99%
rename from src/nix/help-stores.md
rename to doc/manual/src/store/types/index.md.in
index 47ba9b94d..bb166a1fc 100644
--- a/src/nix/help-stores.md
+++ b/doc/manual/src/store/types/index.md.in
@@ -1,5 +1,3 @@
-R"(
-
 Nix supports different types of stores. These are described below.
 
 ## Store URL format
@@ -42,5 +40,3 @@ store as follows:
 * Otherwise, use the [local store](#local-store) `/nix/store`.
 
 @stores@
-
-)"
diff --git a/src/nix/local.mk b/src/nix/local.mk
index 57f8259c4..a21aa705f 100644
--- a/src/nix/local.mk
+++ b/src/nix/local.mk
@@ -31,10 +31,23 @@ src/nix/develop.cc: src/nix/get-env.sh.gen.hh
 
 src/nix-channel/nix-channel.cc: src/nix-channel/unpack-channel.nix.gen.hh
 
-src/nix/main.cc: doc/manual/generate-manpage.nix.gen.hh doc/manual/utils.nix.gen.hh doc/manual/generate-settings.nix.gen.hh doc/manual/generate-store-info.nix.gen.hh
+src/nix/main.cc: \
+  doc/manual/generate-manpage.nix.gen.hh \
+  doc/manual/utils.nix.gen.hh doc/manual/generate-settings.nix.gen.hh \
+  doc/manual/generate-store-info.nix.gen.hh \
+  src/nix/generated-doc/help-stores.md
 
-src/nix/doc/files/%.md: doc/manual/src/command-ref/files/%.md
+src/nix/generated-doc/files/%.md: doc/manual/src/command-ref/files/%.md
 	@mkdir -p $$(dirname $@)
 	@cp $< $@
 
-src/nix/profile.cc: src/nix/profile.md src/nix/doc/files/profiles.md.gen.hh
+src/nix/profile.cc: src/nix/profile.md src/nix/generated-doc/files/profiles.md.gen.hh
+
+src/nix/generated-doc/help-stores.md: doc/manual/src/store/types/index.md.in
+	@mkdir -p $$(dirname $@)
+	@echo 'R"(' >> $@.tmp
+	@echo >> $@.tmp
+	@cat $^ >> $@.tmp
+	@echo >> $@.tmp
+	@echo ')"' >> $@.tmp
+	@mv $@.tmp $@
diff --git a/src/nix/main.cc b/src/nix/main.cc
index 2a6c2f478..49e637fb0 100644
--- a/src/nix/main.cc
+++ b/src/nix/main.cc
@@ -297,7 +297,7 @@ struct CmdHelpStores : Command
     std::string doc() override
     {
         return
-          #include "help-stores.md"
+          #include "generated-doc/help-stores.md"
           ;
     }
 
diff --git a/src/nix/profile.md b/src/nix/profile.md
index bd13f906f..9b2f86f4a 100644
--- a/src/nix/profile.md
+++ b/src/nix/profile.md
@@ -11,7 +11,7 @@ them to be rolled back easily.
 
 )""
 
-#include "doc/files/profiles.md.gen.hh"
+#include "generated-doc/files/profiles.md.gen.hh"
 
 R""(