Date: Fri, 1 May 2026 07:41:11 +0200 From: Benedict Reuschling <bcr@freebsd.org> To: alex@dawnmail.net Cc: freebsd-doc@freebsd.org Subject: Re: 1.2.1. FreeBSD installation process Message-ID: <a6040c6a-dbd1-48b4-a956-7a18edd67fbf@freebsd.org> In-Reply-To: <d166d847-db6c-4cc4-80d1-fb2e1186ef5b@app.fastmail.com> References: <bb39b696-a373-47d1-8fcd-7ea996e04e46@app.fastmail.com> <5eabb317-8827-4350-bd72-a9342e49c31c@FreeBSD.org> <d166d847-db6c-4cc4-80d1-fb2e1186ef5b@app.fastmail.com>
index | next in thread | previous in thread | raw e-mail
[-- Attachment #1 --] Hello Alex, can you submit the patch as a unified diff (diff -u), which is teh preferred patch format that we use? You can also find more information on how to check your patch before submitting and the man pages editing process here: - https://docs.freebsd.org/en/books/fdp-primer/manual-pages/ Thank you! Regards, Benedict Am 01.05.26 um 05:31 schrieb alex@dawnmail.net: > Attached is the mdoc file (/usr/share/man/man1/sh.1.gz) with the correction, sh2.1: > $ diff sh.1 sh2.1 > 34c34 > < .Dd May 1, 2025 > --- >> .Dd May 1, 2026 > 1878,1879c1878,1882 > < Pathname Expansion, > < the four varieties of parameter expansion for substring processing and the > --- >> Pathname Expansion. >> The four varieties of parameter expansion for substring processing are >> described above under >> .Sx Parameter Expansion . >> The > 1881c1884,1885 > < command. > --- >> command is described above under >> .Sx Flow-Control Constructs (if, while, for, case) . > $ > > Is it ok for 'submitting the patch'? > 'mandoc sh2.1' looks good to me. > > > > > > On Thu, Apr 30, 2026, at 8:14 AM, Matthew Seaman wrote: >> On 30/04/2026 12:47,alex@dawnmail.net wrote: >>> I want to submit a patch for 'man sh' (/usr/share/man/man1/sh.1.gz). >>> Step 3 of '1.2.1 FreeBSD installation process' shows the following: >>> >>> 3. Edit the documentation files that require >>> changes. If a file needs major changes, >>> consult the mailing list for input. >>> >>> What is the documentation file for 'man sh'? >> https://github.com/freebsd/freebsd-src/blob/main/bin/sh/sh.1 >> >> Remember to update the date in the .Dd item right below the leading >> comment block. Also, only ever one sentence per line. If you're not >> familiar with how nroff macros work, or even if you are, opening a >> Phabricator review at reviews.freebsd.org would be a good idea, so you >> can get feedback from developers. >> >> Cheers, >> >> Matthew [-- Attachment #2 --] <!DOCTYPE html> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> </head> <body> <p><font face="Helvetica, Arial, sans-serif">Hello Alex,</font></p> <p><font face="Helvetica, Arial, sans-serif">can you submit the patch as a unified diff (diff -u), which is teh preferred patch format that we use?<br> <br> You can also find more information on how to check your patch before submitting and the man pages editing process here:<br> <br> - <a class="moz-txt-link-freetext" href="https://docs.freebsd.org/en/books/fdp-primer/manual-pages/">https://docs.freebsd.org/en/books/fdp-primer/manual-pages/</a><br>; <br> Thank you!</font></p> <p><font face="Helvetica, Arial, sans-serif">Regards,<br> Benedict </font></p> <div class="moz-cite-prefix">Am 01.05.26 um 05:31 schrieb <a class="moz-txt-link-abbreviated" href="mailto:alex@dawnmail.net">alex@dawnmail.net</a>:<br> </div> <blockquote type="cite" cite="mid:d166d847-db6c-4cc4-80d1-fb2e1186ef5b@app.fastmail.com"> <pre wrap="" class="moz-quote-pre">Attached is the mdoc file (/usr/share/man/man1/sh.1.gz) with the correction, sh2.1: $ diff sh.1 sh2.1 34c34 < .Dd May 1, 2025 --- </pre> <blockquote type="cite"> <pre wrap="" class="moz-quote-pre">.Dd May 1, 2026 </pre> </blockquote> <pre wrap="" class="moz-quote-pre">1878,1879c1878,1882 < Pathname Expansion, < the four varieties of parameter expansion for substring processing and the --- </pre> <blockquote type="cite"> <pre wrap="" class="moz-quote-pre">Pathname Expansion. The four varieties of parameter expansion for substring processing are described above under .Sx Parameter Expansion . The </pre> </blockquote> <pre wrap="" class="moz-quote-pre">1881c1884,1885 < command. --- </pre> <blockquote type="cite"> <pre wrap="" class="moz-quote-pre">command is described above under .Sx Flow-Control Constructs (if, while, for, case) . </pre> </blockquote> <pre wrap="" class="moz-quote-pre">$ Is it ok for 'submitting the patch'? 'mandoc sh2.1' looks good to me. On Thu, Apr 30, 2026, at 8:14 AM, Matthew Seaman wrote: </pre> <blockquote type="cite"> <pre wrap="" class="moz-quote-pre">On 30/04/2026 12:47, <a class="moz-txt-link-abbreviated" href="mailto:alex@dawnmail.net">alex@dawnmail.net</a> wrote: </pre> <blockquote type="cite"> <pre wrap="" class="moz-quote-pre">I want to submit a patch for 'man sh' (/usr/share/man/man1/sh.1.gz). Step 3 of '1.2.1 FreeBSD installation process' shows the following: 3. Edit the documentation files that require changes. If a file needs major changes, consult the mailing list for input. What is the documentation file for 'man sh'? </pre> </blockquote> <pre wrap="" class="moz-quote-pre"> <a class="moz-txt-link-freetext" href="https://github.com/freebsd/freebsd-src/blob/main/bin/sh/sh.1">https://github.com/freebsd/freebsd-src/blob/main/bin/sh/sh.1</a>; Remember to update the date in the .Dd item right below the leading comment block. Also, only ever one sentence per line. If you're not familiar with how nroff macros work, or even if you are, opening a Phabricator review at reviews.freebsd.org would be a good idea, so you can get feedback from developers. Cheers, Matthew</pre> </blockquote> </blockquote> </body> </html>home | help
Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?a6040c6a-dbd1-48b4-a956-7a18edd67fbf>