From 4a974e669569a104d389d547bee267aad2661194 Mon Sep 17 00:00:00 2001 From: Jonathan Ringer Date: Sat, 22 May 2021 19:08:23 -0700 Subject: [PATCH] Revert "nixos/doc: convert "Contributing to this manual" to CommonMark" This reverts commit 7501467903faa3de62f6a45d5ee2fda35154b8a2. --- .../contributing-to-this-manual.chapter.md | 13 ----------- .../manual/contributing-to-this-manual.xml | 22 +++++++++++++++++++ .../contributing-to-this-manual.chapter.xml | 22 ------------------- nixos/doc/manual/manual.xml | 2 +- nixos/doc/manual/md-to-db.sh | 3 +-- 5 files changed, 24 insertions(+), 38 deletions(-) delete mode 100644 nixos/doc/manual/contributing-to-this-manual.chapter.md create mode 100644 nixos/doc/manual/contributing-to-this-manual.xml delete mode 100644 nixos/doc/manual/from_md/contributing-to-this-manual.chapter.xml diff --git a/nixos/doc/manual/contributing-to-this-manual.chapter.md b/nixos/doc/manual/contributing-to-this-manual.chapter.md deleted file mode 100644 index 26813d1042d..00000000000 --- a/nixos/doc/manual/contributing-to-this-manual.chapter.md +++ /dev/null @@ -1,13 +0,0 @@ -# Contributing to this manual {#chap-contributing} - -The DocBook and CommonMark sources of NixOS' manual are in the [nixos/doc/manual](https://github.com/NixOS/nixpkgs/tree/master/nixos/doc/manual) subdirectory of the [Nixpkgs](https://github.com/NixOS/nixpkgs) repository. - -You can quickly check your edits with the following: - -```ShellSession -$ cd /path/to/nixpkgs -$ ./nixos/doc/manual/md-to-db.sh -$ nix-build nixos/release.nix -A manual.x86_64-linux -``` - -If the build succeeds, the manual will be in `./result/share/doc/nixos/index.html`. diff --git a/nixos/doc/manual/contributing-to-this-manual.xml b/nixos/doc/manual/contributing-to-this-manual.xml new file mode 100644 index 00000000000..137e04bb313 --- /dev/null +++ b/nixos/doc/manual/contributing-to-this-manual.xml @@ -0,0 +1,22 @@ + + Contributing to this manual + + The DocBook sources of NixOS' manual are in the +nixos/doc/manual subdirectory of the Nixpkgs repository. + + + You can quickly check your edits with the following: + + +$ cd /path/to/nixpkgs +$ nix-build nixos/release.nix -A manual.x86_64-linux + + + If the build succeeds, the manual will be in + ./result/share/doc/nixos/index.html. + + diff --git a/nixos/doc/manual/from_md/contributing-to-this-manual.chapter.xml b/nixos/doc/manual/from_md/contributing-to-this-manual.chapter.xml deleted file mode 100644 index a9b0c6a5eef..00000000000 --- a/nixos/doc/manual/from_md/contributing-to-this-manual.chapter.xml +++ /dev/null @@ -1,22 +0,0 @@ - - Contributing to this manual - - The DocBook and CommonMark sources of NixOS’ manual are in the - nixos/doc/manual - subdirectory of the - Nixpkgs - repository. - - - You can quickly check your edits with the following: - - -$ cd /path/to/nixpkgs -$ ./nixos/doc/manual/md-to-db.sh -$ nix-build nixos/release.nix -A manual.x86_64-linux - - - If the build succeeds, the manual will be in - ./result/share/doc/nixos/index.html. - - diff --git a/nixos/doc/manual/manual.xml b/nixos/doc/manual/manual.xml index 158b3507a58..db9e7313831 100644 --- a/nixos/doc/manual/manual.xml +++ b/nixos/doc/manual/manual.xml @@ -19,6 +19,6 @@ - + diff --git a/nixos/doc/manual/md-to-db.sh b/nixos/doc/manual/md-to-db.sh index fc4be7da22b..a29d981d457 100755 --- a/nixos/doc/manual/md-to-db.sh +++ b/nixos/doc/manual/md-to-db.sh @@ -12,8 +12,8 @@ OUT="$DIR/from_md" mapfile -t MD_FILES < <(find . -type f -regex '.*\.md$') for mf in ${MD_FILES[*]}; do + mkdir -p $(dirname "$OUT/$mf") if [ "${mf: -11}" == ".section.md" ]; then - mkdir -p $(dirname "$OUT/$mf") pandoc "$mf" -t docbook \ --extract-media=media \ -f markdown+smart \ @@ -21,7 +21,6 @@ for mf in ${MD_FILES[*]}; do fi if [ "${mf: -11}" == ".chapter.md" ]; then - mkdir -p $(dirname "$OUT/$mf") pandoc "$mf" -t docbook \ --top-level-division=chapter \ --extract-media=media \