Whamcloud - gitweb
LU-18687 doc: move man pages to Documentation [0] 21/58021/7
authorTimothy Day <timday@amazon.com>
Sat, 29 Mar 2025 22:28:57 +0000 (18:28 -0400)
committerOleg Drokin <green@whamcloud.com>
Thu, 10 Apr 2025 06:54:30 +0000 (06:54 +0000)
Consolidate all of the man pages into the top
level Documentation directory.

Start by setting up the initial directory
structure in Documentation/.

Test-Parameters: trivial
Signed-off-by: Timothy Day <timday@amazon.com>
Change-Id: I15ed0687803513a7726cc5bd53b5ee5eb8f699f0
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/58021
Tested-by: jenkins <devops@whamcloud.com>
Tested-by: Maloo <maloo@whamcloud.com>
Reviewed-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Reviewed-by: Ellis Wilson <elliswilson@microsoft.com>
Reviewed-by: Oleg Drokin <green@whamcloud.com>
14 files changed:
Documentation/.gitignore [new file with mode: 0644]
Documentation/Makefile.am [new file with mode: 0644]
Documentation/man1/.gitignore [new file with mode: 0644]
Documentation/man1/Makefile.am [new file with mode: 0644]
Documentation/man3/.gitignore [new file with mode: 0644]
Documentation/man3/Makefile.am [new file with mode: 0644]
Documentation/man5/.gitignore [new file with mode: 0644]
Documentation/man5/Makefile.am [new file with mode: 0644]
Documentation/man7/.gitignore [new file with mode: 0644]
Documentation/man7/Makefile.am [new file with mode: 0644]
Documentation/man8/.gitignore [new file with mode: 0644]
Documentation/man8/Makefile.am [new file with mode: 0644]
autoMakefile.am
config/lustre-build.m4

diff --git a/Documentation/.gitignore b/Documentation/.gitignore
new file mode 100644 (file)
index 0000000..e4a059f
--- /dev/null
@@ -0,0 +1,15 @@
+/Makefile.in
+/OBD-HOWTO.html
+/OBD-HOWTO.txt
+/lustre-HOWTO.lyx
+/lustre-HOWTO.txt
+/lustre-pdf.bbl
+/lustre-pdf.blg
+/lustre-pdf.log
+/lustre-pdf.out
+/lustre-pdf.toc
+/*.eps
+/lustre.lyx
+/*.tex
+/*.pdf
+/*.aux
diff --git a/Documentation/Makefile.am b/Documentation/Makefile.am
new file mode 100644 (file)
index 0000000..657c130
--- /dev/null
@@ -0,0 +1,9 @@
+# SPDX-License-Identifier: GPL-2.0
+
+#
+# This file is part of Lustre, http://www.lustre.org/
+#
+
+ALWAYS_SUBDIRS = man1 man3 man5 man7 man8
+SUBDIRS := $(ALWAYS_SUBDIRS)
+DIST_SUBDIRS := $(ALWAYS_SUBDIRS)
diff --git a/Documentation/man1/.gitignore b/Documentation/man1/.gitignore
new file mode 100644 (file)
index 0000000..10a7e8d
--- /dev/null
@@ -0,0 +1 @@
+/Makefile.in
diff --git a/Documentation/man1/Makefile.am b/Documentation/man1/Makefile.am
new file mode 100644 (file)
index 0000000..6e53ab5
--- /dev/null
@@ -0,0 +1,18 @@
+# SPDX-License-Identifier: GPL-2.0
+
+#
+# This file is part of Lustre, http://www.lustre.org/
+#
+
+MANFILES =
+
+if MANPAGES
+if UTILS
+man_MANS = $(MANFILES)
+endif
+endif
+
+CLEANFILES = *.aux *.tex *.log *.pdf
+EXTRA_DIST = $(MANFILES)
+
+all:
diff --git a/Documentation/man3/.gitignore b/Documentation/man3/.gitignore
new file mode 100644 (file)
index 0000000..10a7e8d
--- /dev/null
@@ -0,0 +1 @@
+/Makefile.in
diff --git a/Documentation/man3/Makefile.am b/Documentation/man3/Makefile.am
new file mode 100644 (file)
index 0000000..6e53ab5
--- /dev/null
@@ -0,0 +1,18 @@
+# SPDX-License-Identifier: GPL-2.0
+
+#
+# This file is part of Lustre, http://www.lustre.org/
+#
+
+MANFILES =
+
+if MANPAGES
+if UTILS
+man_MANS = $(MANFILES)
+endif
+endif
+
+CLEANFILES = *.aux *.tex *.log *.pdf
+EXTRA_DIST = $(MANFILES)
+
+all:
diff --git a/Documentation/man5/.gitignore b/Documentation/man5/.gitignore
new file mode 100644 (file)
index 0000000..10a7e8d
--- /dev/null
@@ -0,0 +1 @@
+/Makefile.in
diff --git a/Documentation/man5/Makefile.am b/Documentation/man5/Makefile.am
new file mode 100644 (file)
index 0000000..6e53ab5
--- /dev/null
@@ -0,0 +1,18 @@
+# SPDX-License-Identifier: GPL-2.0
+
+#
+# This file is part of Lustre, http://www.lustre.org/
+#
+
+MANFILES =
+
+if MANPAGES
+if UTILS
+man_MANS = $(MANFILES)
+endif
+endif
+
+CLEANFILES = *.aux *.tex *.log *.pdf
+EXTRA_DIST = $(MANFILES)
+
+all:
diff --git a/Documentation/man7/.gitignore b/Documentation/man7/.gitignore
new file mode 100644 (file)
index 0000000..10a7e8d
--- /dev/null
@@ -0,0 +1 @@
+/Makefile.in
diff --git a/Documentation/man7/Makefile.am b/Documentation/man7/Makefile.am
new file mode 100644 (file)
index 0000000..6e53ab5
--- /dev/null
@@ -0,0 +1,18 @@
+# SPDX-License-Identifier: GPL-2.0
+
+#
+# This file is part of Lustre, http://www.lustre.org/
+#
+
+MANFILES =
+
+if MANPAGES
+if UTILS
+man_MANS = $(MANFILES)
+endif
+endif
+
+CLEANFILES = *.aux *.tex *.log *.pdf
+EXTRA_DIST = $(MANFILES)
+
+all:
diff --git a/Documentation/man8/.gitignore b/Documentation/man8/.gitignore
new file mode 100644 (file)
index 0000000..10a7e8d
--- /dev/null
@@ -0,0 +1 @@
+/Makefile.in
diff --git a/Documentation/man8/Makefile.am b/Documentation/man8/Makefile.am
new file mode 100644 (file)
index 0000000..6e53ab5
--- /dev/null
@@ -0,0 +1,18 @@
+# SPDX-License-Identifier: GPL-2.0
+
+#
+# This file is part of Lustre, http://www.lustre.org/
+#
+
+MANFILES =
+
+if MANPAGES
+if UTILS
+man_MANS = $(MANFILES)
+endif
+endif
+
+CLEANFILES = *.aux *.tex *.log *.pdf
+EXTRA_DIST = $(MANFILES)
+
+all:
index 7de2025..3e88adb 100644 (file)
@@ -13,6 +13,7 @@
 SUBDIRS := @LDISKFS_SUBDIR@ \
        . \
        @LUSTREIOKIT_SUBDIR@ \
+       Documentation \
        lustre_compat \
        libcfs \
        lnet \
@@ -20,6 +21,7 @@ SUBDIRS := @LDISKFS_SUBDIR@ \
 
 DIST_SUBDIRS := ldiskfs \
        lustre-iokit \
+       Documentation \
        lustre_compat \
        libcfs \
        lnet \
index 7b2653a..2217315 100644 (file)
@@ -429,6 +429,12 @@ AC_DEFUN([LB_CONFIG_FILES], [
                lustre-iokit/ior-survey/Makefile
                lustre-iokit/stats-collect/Makefile
                lustre-iokit/lst-survey/Makefile
+               Documentation/Makefile
+               Documentation/man1/Makefile
+               Documentation/man3/Makefile
+               Documentation/man5/Makefile
+               Documentation/man7/Makefile
+               Documentation/man8/Makefile
        )
 ])