Hi Ellis, On Mon, Jan 13, 2025 at 03:33:07PM +0000, Ellis Wilson wrote: > Hi Alejandro, > > I am assisting with updating Lustre documentation within the Lustre > community. Lustre is an HPC filesystem used at >50% of the top 500 > supercomputers in the world. It is not presently in-tree in the > kernel, but was in staging some years ago, and there is on-going work > to try to get it back in-tree someday. I'm reaching out to see if > there is any interest in including Lustre manpages on man7.org? If > there is no interest or I should discuss this with someone else please > don't hesitate to say so. man7.org is Michael Kerrisk's server. You should contact him at <man-pages@xxxxxxxx>. I've CCd him in this email. > The manpages for Lustre can be found here if you would like to review > their count or contents: > https://github.com/lustre/lustre-release/tree/master/lustre/doc A few suggestions: - Use subdirectories (man1/, man3/, man5/, man7/, man8/) for the different chapters. That allows reading the link (.so) pages within the source repository. - I found some warnings when linting those pages with the build system of the Linux man-pages project. Here's a fraction of the logs: alx@devuan:/srv/alx/src/linux/man-pages/man-pages/main$ make MANDIR=/tmp/man/lustre/lustre-release/lustre/doc lint-man -k MANDOC .tmp/man/lfs-changelog.1.lint-man.mandoc.touch mandoc: .tmp/man/lfs-changelog.1:3:88: STYLE: input text line longer than 80 bytes: lfs-changelog, lfs-c... make: *** [/srv/alx/src/linux/man-pages/man-pages/main/share/mk/lint/man/mandoc.mk:36: .tmp/man/lfs-changelog.1.lint-man.mandoc.touch] Error 1 MANDOC .tmp/man/lfs-find.1.lint-man.mandoc.touch mandoc: .tmp/man/lfs-find.1:610:2: ERROR: skipping end of block that is not open: RE mandoc: .tmp/man/lfs-find.1:794:35: STYLE: unterminated quoted argument mandoc: .tmp/man/lfs-find.1:1:16: WARNING: cannot parse date, using it verbatim: TH 2024-08-15" make: *** [/srv/alx/src/linux/man-pages/man-pages/main/share/mk/lint/man/mandoc.mk:36: .tmp/man/lfs-find.1.lint-man.mandoc.touch] Error 1 MANDOC .tmp/man/lfs-getsom.1.lint-man.mandoc.touch mandoc: .tmp/man/lfs-getsom.1:23:2: ERROR: skipping unknown macro: .Ex mandoc: .tmp/man/lfs-getsom.1:30:2: STYLE: fill mode already enabled, skipping: EE make: *** [/srv/alx/src/linux/man-pages/man-pages/main/share/mk/lint/man/mandoc.mk:36: .tmp/man/lfs-getsom.1.lint-man.mandoc.touch] Error 1 MANDOC .tmp/man/lfs-hsm.1.lint-man.mandoc.touch mandoc: .tmp/man/lfs-hsm.1:3:92: STYLE: input text line longer than 80 bytes: hsm_state, hsm_actio... mandoc: .tmp/man/lfs-hsm.1:27:81: STYLE: input text line longer than 80 bytes: These are a set of l... make: *** [/srv/alx/src/linux/man-pages/man-pages/main/share/mk/lint/man/mandoc.mk:36: .tmp/man/lfs-hsm.1.lint-man.mandoc.touch] Error 1 MANDOC .tmp/man/lfs-migrate.1.lint-man.mandoc.touch mandoc: .tmp/man/lfs-migrate.1:153:84: STYLE: input text line longer than 80 bytes: Do not set LMV_HASH_... mandoc: .tmp/man/lfs-migrate.1:13:2: WARNING: skipping paragraph macro: br at the end of SH mandoc: .tmp/man/lfs-migrate.1:21:2: WARNING: skipping paragraph macro: PP after SH mandoc: .tmp/man/lfs-migrate.1:178:2: WARNING: skipping paragraph macro: PP empty mandoc: .tmp/man/lfs-migrate.1:202:2: WARNING: skipping paragraph macro: PP empty [...] You probably want to address most of those. If you have any doubts using the build system of the Linux man-pages project to lint your own pages, feel free to ask, CCing the mailing list. > Thank you for your consideration! > > Best, > > ellis Have a lovely day! Alex -- <https://www.alejandro-colomar.es/>
Attachment:
signature.asc
Description: PGP signature
