From 540e9699ccfb91e57ff2fcd51d0ed9414db7de6c Mon Sep 17 00:00:00 2001 From: Timothy Day Date: Sat, 29 Mar 2025 18:28:57 -0400 Subject: [PATCH] LU-18687 doc: move man pages to Documentation [0] 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 Change-Id: I15ed0687803513a7726cc5bd53b5ee5eb8f699f0 Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/58021 Tested-by: jenkins Tested-by: Maloo Reviewed-by: Arshad Hussain Reviewed-by: Ellis Wilson Reviewed-by: Oleg Drokin --- Documentation/.gitignore | 15 +++++++++++++++ Documentation/Makefile.am | 9 +++++++++ Documentation/man1/.gitignore | 1 + Documentation/man1/Makefile.am | 18 ++++++++++++++++++ Documentation/man3/.gitignore | 1 + Documentation/man3/Makefile.am | 18 ++++++++++++++++++ Documentation/man5/.gitignore | 1 + Documentation/man5/Makefile.am | 18 ++++++++++++++++++ Documentation/man7/.gitignore | 1 + Documentation/man7/Makefile.am | 18 ++++++++++++++++++ Documentation/man8/.gitignore | 1 + Documentation/man8/Makefile.am | 18 ++++++++++++++++++ autoMakefile.am | 2 ++ config/lustre-build.m4 | 6 ++++++ 14 files changed, 127 insertions(+) create mode 100644 Documentation/.gitignore create mode 100644 Documentation/Makefile.am create mode 100644 Documentation/man1/.gitignore create mode 100644 Documentation/man1/Makefile.am create mode 100644 Documentation/man3/.gitignore create mode 100644 Documentation/man3/Makefile.am create mode 100644 Documentation/man5/.gitignore create mode 100644 Documentation/man5/Makefile.am create mode 100644 Documentation/man7/.gitignore create mode 100644 Documentation/man7/Makefile.am create mode 100644 Documentation/man8/.gitignore create mode 100644 Documentation/man8/Makefile.am diff --git a/Documentation/.gitignore b/Documentation/.gitignore new file mode 100644 index 0000000..e4a059f --- /dev/null +++ b/Documentation/.gitignore @@ -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 index 0000000..657c130 --- /dev/null +++ b/Documentation/Makefile.am @@ -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 index 0000000..10a7e8d --- /dev/null +++ b/Documentation/man1/.gitignore @@ -0,0 +1 @@ +/Makefile.in diff --git a/Documentation/man1/Makefile.am b/Documentation/man1/Makefile.am new file mode 100644 index 0000000..6e53ab5 --- /dev/null +++ b/Documentation/man1/Makefile.am @@ -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 index 0000000..10a7e8d --- /dev/null +++ b/Documentation/man3/.gitignore @@ -0,0 +1 @@ +/Makefile.in diff --git a/Documentation/man3/Makefile.am b/Documentation/man3/Makefile.am new file mode 100644 index 0000000..6e53ab5 --- /dev/null +++ b/Documentation/man3/Makefile.am @@ -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 index 0000000..10a7e8d --- /dev/null +++ b/Documentation/man5/.gitignore @@ -0,0 +1 @@ +/Makefile.in diff --git a/Documentation/man5/Makefile.am b/Documentation/man5/Makefile.am new file mode 100644 index 0000000..6e53ab5 --- /dev/null +++ b/Documentation/man5/Makefile.am @@ -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 index 0000000..10a7e8d --- /dev/null +++ b/Documentation/man7/.gitignore @@ -0,0 +1 @@ +/Makefile.in diff --git a/Documentation/man7/Makefile.am b/Documentation/man7/Makefile.am new file mode 100644 index 0000000..6e53ab5 --- /dev/null +++ b/Documentation/man7/Makefile.am @@ -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 index 0000000..10a7e8d --- /dev/null +++ b/Documentation/man8/.gitignore @@ -0,0 +1 @@ +/Makefile.in diff --git a/Documentation/man8/Makefile.am b/Documentation/man8/Makefile.am new file mode 100644 index 0000000..6e53ab5 --- /dev/null +++ b/Documentation/man8/Makefile.am @@ -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/autoMakefile.am b/autoMakefile.am index 7de2025..3e88adb 100644 --- a/autoMakefile.am +++ b/autoMakefile.am @@ -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 \ diff --git a/config/lustre-build.m4 b/config/lustre-build.m4 index 7b2653a..2217315 100644 --- a/config/lustre-build.m4 +++ b/config/lustre-build.m4 @@ -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 ) ]) -- 1.8.3.1