From: Jörg Behrmann <behrmann@physik.fu-berlin.de>
Date: Fri, 30 Aug 2024 09:16:50 +0000 (+0200)
Subject: doc: move man pages to resources/man
X-Git-Tag: v25~317^2~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6e21cceb03b211625e72b60c727c7712d1122ba2;p=thirdparty%2Fmkosi.git

doc: move man pages to resources/man
---

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index d209205d8..2524f06b2 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -85,7 +85,7 @@ jobs:
           bin/mkosi completion bash | shellcheck -
 
       - name: Test man page generation
-        run: pandoc -s mkosi.md -o mkosi.1
+        run: tools/make-man-page.sh
 
   integration-test:
     runs-on: ubuntu-24.04
diff --git a/mkosi/__init__.py b/mkosi/__init__.py
index 4553bc3b9..3d76f674c 100644
--- a/mkosi/__init__.py
+++ b/mkosi/__init__.py
@@ -3596,7 +3596,7 @@ def show_docs(args: Args, *, resources: Path) -> None:
         form = formats.pop(0)
         try:
             if form == DocFormat.man:
-                man = resources / "mkosi.1"
+                man = resources / "man/mkosi.1"
                 if not man.exists():
                     raise FileNotFoundError()
                 run(["man", "--local-file", man])
@@ -3604,11 +3604,11 @@ def show_docs(args: Args, *, resources: Path) -> None:
             elif form == DocFormat.pandoc:
                 if not find_binary("pandoc"):
                     logging.error("pandoc is not available")
-                pandoc = run(["pandoc", "-t", "man", "-s", resources / "mkosi.md"], stdout=subprocess.PIPE)
+                pandoc = run(["pandoc", "-t", "man", "-s", resources / "man/mkosi.md"], stdout=subprocess.PIPE)
                 run(["man", "--local-file", "-"], input=pandoc.stdout)
                 return
             elif form == DocFormat.markdown:
-                page((resources / "mkosi.md").read_text(), args.pager)
+                page((resources / "man/mkosi.md").read_text(), args.pager)
                 return
             elif form == DocFormat.system:
                 run(["man", "mkosi"])
diff --git a/mkosi/initrd/resources/__init__.py b/mkosi/initrd/resources/__init__.py
deleted file mode 100644
index e69de29bb..000000000
diff --git a/mkosi/initrd/resources/mkosi-initrd.md b/mkosi/resources/man/mkosi-initrd.md
similarity index 100%
rename from mkosi/initrd/resources/mkosi-initrd.md
rename to mkosi/resources/man/mkosi-initrd.md
diff --git a/mkosi/sandbox/resources/mkosi-sandbox.md b/mkosi/resources/man/mkosi-sandbox.md
similarity index 100%
rename from mkosi/sandbox/resources/mkosi-sandbox.md
rename to mkosi/resources/man/mkosi-sandbox.md
diff --git a/mkosi/resources/mkosi.md b/mkosi/resources/man/mkosi.md
similarity index 100%
rename from mkosi/resources/mkosi.md
rename to mkosi/resources/man/mkosi.md
diff --git a/pyproject.toml b/pyproject.toml
index 780148be7..04f5d818d 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -36,7 +36,7 @@ packages = [
 ]
 
 [tool.setuptools.package-data]
-"mkosi.resources" = ["repart/**/*", "mkosi.md", "mkosi.1", "mkosi-initrd/**/*", "mkosi-tools/**/*"]
+"mkosi.resources" = ["repart/**/*", "man/*", "mkosi-initrd/**/*", "mkosi-tools/**/*"]
 "mkosi.initrd.resources" = ["mkosi-initrd.md", "mkosi-initrd.1"]
 "mkosi.sandbox.resources" = ["mkosi-sandbox.md", "mkosi-sandbox.1"]
 
diff --git a/tools/make-man-page.sh b/tools/make-man-page.sh
index 17c5cd706..a6303163f 100755
--- a/tools/make-man-page.sh
+++ b/tools/make-man-page.sh
@@ -2,6 +2,6 @@
 # SPDX-License-Identifier: LGPL-2.1-or-later
 set -ex
 
-pandoc -t man -s -o mkosi/resources/mkosi.1 mkosi/resources/mkosi.md
-pandoc -t man -s -o mkosi/initrd/resources/mkosi-initrd.1 mkosi/initrd/resources/mkosi-initrd.md
-pandoc -t man -s -o mkosi/sandbox/resources/mkosi-sandbox.1 mkosi/sandbox/resources/mkosi-sandbox.md
+pandoc -t man -s -o mkosi/resources/man/mkosi.1 mkosi/resources/man/mkosi.md
+pandoc -t man -s -o mkosi/resources/man/mkosi-initrd.1 mkosi/resources/man/mkosi-initrd.md
+pandoc -t man -s -o mkosi/resources/man/mkosi-sandbox.1 mkosi/resources/man/mkosi-sandbox.md