nixos/manual: move "edit the MD file" comments to generated XML

85 files changed, 87 insertions, 42 deletions

diff --git a/nixos/doc/manual/md-to-db.sh b/nixos/doc/manual/md-to-db.sh
index abf9417c50a2..a7421bed532e 100755
--- a/nixos/doc/manual/md-to-db.sh
+++ b/nixos/doc/manual/md-to-db.sh
@@ -62,6 +62,9 @@ for mf in ${MD_FILES[*]}; do
   [ -f "${mf%.md}.nix" ] || continue
 
   pandoc --top-level-division=chapter "$mf" "${pandoc_flags[@]}" -o "${mf%.md}.xml"
+  sed -i -e '1 i <!-- Do not edit this file directly, edit its companion .md instead\
+     and regenerate this file using nixos/doc/manual/md-to-db.sh -->' \
+    "${mf%.md}.xml"
 done
 
 popd
diff --git a/nixos/modules/i18n/input-method/default.nix b/nixos/modules/i18n/input-method/default.nix
index 452b0d7b264e..07fb86bcc25e 100644
--- a/nixos/modules/i18n/input-method/default.nix
+++ b/nixos/modules/i18n/input-method/default.nix
@@ -66,7 +66,6 @@ in
 
   meta = {
     maintainers = with lib.maintainers; [ ericsagnes ];
-    # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh
     doc = ./default.xml;
   };
 
diff --git a/nixos/modules/i18n/input-method/default.xml b/nixos/modules/i18n/input-method/default.xml
index b3706086befd..7b7907cd32a6 100644
--- a/nixos/modules/i18n/input-method/default.xml
+++ b/nixos/modules/i18n/input-method/default.xml
@@ -1,3 +1,5 @@
+<!-- Do not edit this file directly, edit its companion .md instead
+     and regenerate this file using nixos/doc/manual/md-to-db.sh -->
 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-services-input-methods">
   <title>Input Methods</title>
   <para>
diff --git a/nixos/modules/programs/digitalbitbox/default.nix b/nixos/modules/programs/digitalbitbox/default.nix
index fb18c52187b6..054110fe5df2 100644
--- a/nixos/modules/programs/digitalbitbox/default.nix
+++ b/nixos/modules/programs/digitalbitbox/default.nix
@@ -33,7 +33,6 @@ in
   };
 
   meta = {
-    # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh
     doc = ./default.xml;
     maintainers = with lib.maintainers; [ vidbina ];
   };
diff --git a/nixos/modules/programs/digitalbitbox/default.xml b/nixos/modules/programs/digitalbitbox/default.xml
index d5e1110bafb2..ee892523223c 100644
--- a/nixos/modules/programs/digitalbitbox/default.xml
+++ b/nixos/modules/programs/digitalbitbox/default.xml
@@ -1,3 +1,5 @@
+<!-- Do not edit this file directly, edit its companion .md instead
+     and regenerate this file using nixos/doc/manual/md-to-db.sh -->
 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-programs-digitalbitbox">
   <title>Digital Bitbox</title>
   <para>
diff --git a/nixos/modules/programs/plotinus.nix b/nixos/modules/programs/plotinus.nix
index cc73df2f791f..a011bb862aea 100644
--- a/nixos/modules/programs/plotinus.nix
+++ b/nixos/modules/programs/plotinus.nix
@@ -8,7 +8,6 @@ in
 {
   meta = {
     maintainers = pkgs.plotinus.meta.maintainers;
-    # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh
     doc = ./plotinus.xml;
   };
 
diff --git a/nixos/modules/programs/plotinus.xml b/nixos/modules/programs/plotinus.xml
index eb8c65f94bc9..2d4db0285148 100644
--- a/nixos/modules/programs/plotinus.xml
+++ b/nixos/modules/programs/plotinus.xml
@@ -1,3 +1,5 @@
+<!-- Do not edit this file directly, edit its companion .md instead
+     and regenerate this file using nixos/doc/manual/md-to-db.sh -->
 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-program-plotinus">
   <title>Plotinus</title>
   <para>
diff --git a/nixos/modules/programs/zsh/oh-my-zsh.nix b/nixos/modules/programs/zsh/oh-my-zsh.nix
index a2d6eb14bdfd..41ea31b0f122 100644
--- a/nixos/modules/programs/zsh/oh-my-zsh.nix
+++ b/nixos/modules/programs/zsh/oh-my-zsh.nix
@@ -142,6 +142,5 @@ in
 
     };
 
-    # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh
     meta.doc = ./oh-my-zsh.xml;
   }
diff --git a/nixos/modules/programs/zsh/oh-my-zsh.xml b/nixos/modules/programs/zsh/oh-my-zsh.xml
index be868326c25b..2a2bba96b859 100644
--- a/nixos/modules/programs/zsh/oh-my-zsh.xml
+++ b/nixos/modules/programs/zsh/oh-my-zsh.xml
@@ -1,3 +1,5 @@
+<!-- Do not edit this file directly, edit its companion .md instead
+     and regenerate this file using nixos/doc/manual/md-to-db.sh -->
 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-programs-zsh-ohmyzsh">
   <title>Oh my ZSH</title>
   <para>
diff --git a/nixos/modules/security/acme/default.nix b/nixos/modules/security/acme/default.nix
index baa7a516ce34..06db420632e5 100644
--- a/nixos/modules/security/acme/default.nix
+++ b/nixos/modules/security/acme/default.nix
@@ -916,7 +916,6 @@ in {
 
   meta = {
     maintainers = lib.teams.acme.members;
-    # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh
     doc = ./default.xml;
   };
 }
diff --git a/nixos/modules/security/acme/default.xml b/nixos/modules/security/acme/default.xml
index 766421c62373..e80ce3b6a494 100644
--- a/nixos/modules/security/acme/default.xml
+++ b/nixos/modules/security/acme/default.xml
@@ -1,3 +1,5 @@
+<!-- Do not edit this file directly, edit its companion .md instead
+     and regenerate this file using nixos/doc/manual/md-to-db.sh -->
 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-security-acme">
   <title>SSL/TLS Certificates with ACME</title>
   <para>
diff --git a/nixos/modules/services/backup/borgbackup.nix b/nixos/modules/services/backup/borgbackup.nix
index 5489aac0111f..c5fc09dcea02 100644
--- a/nixos/modules/services/backup/borgbackup.nix
+++ b/nixos/modules/services/backup/borgbackup.nix
@@ -226,7 +226,6 @@ let
 
 in {
   meta.maintainers = with maintainers; [ dotlambda ];
-  # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh
   meta.doc = ./borgbackup.xml;
 
   ###### interface
diff --git a/nixos/modules/services/backup/borgbackup.xml b/nixos/modules/services/backup/borgbackup.xml
index 1b864d6cdd56..2b9e0baa6d09 100644
--- a/nixos/modules/services/backup/borgbackup.xml
+++ b/nixos/modules/services/backup/borgbackup.xml
@@ -1,3 +1,5 @@
+<!-- Do not edit this file directly, edit its companion .md instead
+     and regenerate this file using nixos/doc/manual/md-to-db.sh -->
 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-borgbase">
   <title>BorgBackup</title>
   <para>
diff --git a/nixos/modules/services/databases/foundationdb.nix b/nixos/modules/services/databases/foundationdb.nix
index 3d72d8ec6d27..16d539b661eb 100644
--- a/nixos/modules/services/databases/foundationdb.nix
+++ b/nixos/modules/services/databases/foundationdb.nix
@@ -424,7 +424,6 @@ in
     };
   };
 
-  # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh
   meta.doc         = ./foundationdb.xml;
   meta.maintainers = with lib.maintainers; [ thoughtpolice ];
 }
diff --git a/nixos/modules/services/databases/foundationdb.xml b/nixos/modules/services/databases/foundationdb.xml
index e4a012604215..611535a9eb8a 100644
--- a/nixos/modules/services/databases/foundationdb.xml
+++ b/nixos/modules/services/databases/foundationdb.xml
@@ -1,3 +1,5 @@
+<!-- Do not edit this file directly, edit its companion .md instead
+     and regenerate this file using nixos/doc/manual/md-to-db.sh -->
 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-services-foundationdb">
   <title>FoundationDB</title>
   <para>
diff --git a/nixos/modules/services/databases/postgresql.nix b/nixos/modules/services/databases/postgresql.nix
index 40a1acb39a3d..6665e7a088fc 100644
--- a/nixos/modules/services/databases/postgresql.nix
+++ b/nixos/modules/services/databases/postgresql.nix
@@ -585,7 +585,6 @@ in
 
   };
 
-  # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh
   meta.doc = ./postgresql.xml;
   meta.maintainers = with lib.maintainers; [ thoughtpolice danbst ];
 }
diff --git a/nixos/modules/services/databases/postgresql.xml b/nixos/modules/services/databases/postgresql.xml
index 6aa2a3812ffa..2f62d5d80b19 100644
--- a/nixos/modules/services/databases/postgresql.xml
+++ b/nixos/modules/services/databases/postgresql.xml
@@ -1,3 +1,5 @@
+<!-- Do not edit this file directly, edit its companion .md instead
+     and regenerate this file using nixos/doc/manual/md-to-db.sh -->
 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-postgresql">
   <title>PostgreSQL</title>
   <para>
diff --git a/nixos/modules/services/desktops/flatpak.nix b/nixos/modules/services/desktops/flatpak.nix
index b08d7db226da..3b14ad75ab30 100644
--- a/nixos/modules/services/desktops/flatpak.nix
+++ b/nixos/modules/services/desktops/flatpak.nix
@@ -7,7 +7,6 @@ let
   cfg = config.services.flatpak;
 in {
   meta = {