diff options
| author | Alexander Ziaee <concussious@runbox.com> | 2024-05-10 06:07:59 +0000 |
|---|---|---|
| committer | Warner Losh <imp@FreeBSD.org> | 2024-05-10 21:07:03 +0000 |
| commit | 467e3e2f2052faa012e6100915b6f99a0c74bfb9 (patch) | |
| tree | 37ba34e11b04f65fab7e798070ffe4780bf0a659 | |
| parent | a7cc56b28fb1615a8ac4ebe826312a5d8a0f17da (diff) | |
| download | src-467e3e2f2052faa012e6100915b6f99a0c74bfb9.tar.gz src-467e3e2f2052faa012e6100915b6f99a0c74bfb9.zip | |
CONTRIBUTING.md/style: spring cleaning
+ move Lua to alphabetize subsections
+ word manpages like other subsections
+ man PR's shouldn't bump document date
MFC after: (maybe MFC to BETA3 along w/ e7ff917057ea ?)
| -rw-r--r-- | CONTRIBUTING.md | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c26b1d335c5f..8e79652a09d2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -106,19 +106,21 @@ command can help minimize churn by only formatting the areas nearby the changes. not perfect, using these tools will maximize your chances of not having style comments on your pull requests. +For [Lua](https://www.lua.org), see +[style.lua(9)](https://man.freebsd.org/cgi/man.cgi?query=style.lua&sektion=9) +for details. Lua is used for the boot loader and a few scripts in the base system. + For Makefiles changes, see [style.Makefile(5)](https://man.freebsd.org/cgi/man.cgi?query=style.Makefile&sektion=5) for details. FreeBSD's base system uses the in-tree make, not GNU Make, so [make(1)](https://man.freebsd.org/cgi/man.cgi?query=make&sektion=1) is another useful resource. -The project uses mdoc for all its man pages. Changes should pass `mandoc -Tlint` and igor (install the latter with `pkg install igor`). -Please be sure to observe the one-sentence-per-line rule so manual pages properly render. Any semantic changes to the manual pages should bump the date. -[style.mdoc(5)](https://man.freebsd.org/cgi/man.cgi?query=style.mdoc&sektion=5) has the all details. - -For [Lua](https://www.lua.org), please see -[style.lua(9)](https://man.freebsd.org/cgi/man.cgi?query=style.lua&sektion=9) -for details. Lua is used for the boot loader and a few scripts in the base system. +For manual page changes, see +[style.mdoc(5)](https://man.freebsd.org/cgi/man.cgi?query=style.mdoc&sektion=5) +for details. Changes should pass `mandoc -Tlint` and igor (install the latter with `pkg install igor`). +Please be sure to observe the one-sentence-per-line rule so manual pages properly render. +Proposed changes to manual pages should not bump the document date until merged. For shell scripts, avoid using bash. The system shell (/bin/sh) is preferred. Shell scripts in the base system cannot use bash or bash extensions |