Date: Sat, 2 May 2026 21:12:11 +0200 From: Benedict Reuschling <bcr@freebsd.org> To: freebsd-doc@freebsd.org Subject: Re: 1.2.1. FreeBSD installation process Message-ID: <93babe49-495d-4f81-83af-2be28ef71a37@freebsd.org> In-Reply-To: <fe896f2b-d935-4fad-a00d-c71d2c9e3a8c@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> <a6040c6a-dbd1-48b4-a956-7a18edd67fbf@freebsd.org> <fe896f2b-d935-4fad-a00d-c71d2c9e3a8c@app.fastmail.com>
index | next in thread | previous in thread | raw e-mail
[-- Attachment #1 --] Hi Alex, thanks for the patch. It does not apply cleanly, here is what I get: Patching file sh.1 using Plan A... Hunk #1 failed at 31. Hunk #2 succeeded at 1894 (offset 19 lines). Hunk #3 failed at 2396. 2 out of 3 hunks failed--saving rejects to sh.1.rej And the .rej file has this: @@ -31,7 +31,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd May 1, 2025 +.Dd May 1, 2026 .Dt SH 1 .Os .Sh NAME @@ -2392,7 +2396,7 @@ .Va optstring or if it is missing a required argument, the option is considered invalid and: -.Bl -offset indent +.Bl -item -offset indent .It If the first character of .Va optstring Are you sure you're using the latest version of the source tree to create your patch? Regards, Benedict Am 01.05.26 um 19:37 schrieb alex@dawnmail.net: > Hello Benedict, > > Attached is the new mdoc file (sh3.1) along with the output of "diff > -u sh.1 sh3.1". > Please let me know if you have any questions. > > Thanks, > Alex > > > > > On Fri, May 1, 2026, at 12:41 AM, Benedict Reuschling wrote: >> >> 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/ >> <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 >> <mailto: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 <mailto: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 <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">Hi Alex,</font></p> <p><font face="Helvetica, Arial, sans-serif">thanks for the patch. It does not apply cleanly, here is what I get:<br> <br> </font><font face="Courier New, Courier, monospace">Patching file sh.1 using Plan A...<br> Hunk #1 failed at 31.<br> Hunk #2 succeeded at 1894 (offset 19 lines).<br> Hunk #3 failed at 2396.<br> 2 out of 3 hunks failed--saving rejects to sh.1.rej</font><font face="Helvetica, Arial, sans-serif"><br> <br> And the .rej file has this:<br> </font><font face="Courier New, Courier, monospace"><br> @@ -31,7 +31,7 @@<br> .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF<br> .\" SUCH DAMAGE.<br> .\"<br> -.Dd May 1, 2025<br> +.Dd May 1, 2026<br> .Dt SH 1<br> .Os<br> .Sh NAME<br> @@ -2392,7 +2396,7 @@<br> .Va optstring<br> or if it is missing a required argument,<br> the option is considered invalid and:<br> -.Bl -offset indent<br> +.Bl -item -offset indent<br> .It<br> If the first character of<br> .Va optstring</font><font face="Helvetica, Arial, sans-serif"><br> <br> Are you sure you're using the latest version of the source tree to create your patch?<br> <br> Regards,<br> Benedict</font></p> <div class="moz-cite-prefix">Am 01.05.26 um 19:37 schrieb <a class="moz-txt-link-abbreviated" href="mailto:alex@dawnmail.net">alex@dawnmail.net</a>:<br> </div> <blockquote type="cite" cite="mid:fe896f2b-d935-4fad-a00d-c71d2c9e3a8c@app.fastmail.com"> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title></title> <div>Hello Benedict,</div> <div><br> </div> <div>Attached is the new mdoc file (sh3.1) along with the output of "diff -u sh.1 sh3.1".</div> <div>Please let me know if you have any questions.</div> <div><br> </div> <div>Thanks,</div> <div>Alex</div> <div><br> </div> <div><br> </div> <div><br> </div> <div><br> </div> <div>On Fri, May 1, 2026, at 12:41 AM, Benedict Reuschling wrote:</div> <blockquote type="cite" id="qt" style=""> <p><span class="font" style="font-family:Helvetica, Arial, sans-serif;">Hello Alex,</span></p> <p><span class="font" style="font-family: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="qt-moz-txt-link-freetext moz-txt-link-freetext" href="https://docs.freebsd.org/en/books/fdp-primer/manual-pages/" moz-do-not-send="true">https://docs.freebsd.org/en/books/fdp-primer/manual-pages/</a><br>; <br> Thank you!</span></p> <p><span class="font" style="font-family:Helvetica, Arial, sans-serif;">Regards,<br> Benedict </span></p> <div class="qt-moz-cite-prefix">Am 01.05.26 um 05:31 schrieb <a class="qt-moz-txt-link-abbreviated moz-txt-link-freetext" href="mailto:alex@dawnmail.net" moz-do-not-send="true">alex@dawnmail.net</a>:</div> <blockquote type="cite" cite="mid:d166d847-db6c-4cc4-80d1-fb2e1186ef5b@app.fastmail.com"> <pre class="qt-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 class="qt-moz-quote-pre">.Dd May 1, 2026 </pre> </blockquote> <pre class="qt-moz-quote-pre">1878,1879c1878,1882 < Pathname Expansion, < the four varieties of parameter expansion for substring processing and the --- </pre> <blockquote type="cite"> <pre class="qt-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 class="qt-moz-quote-pre">1881c1884,1885 < command. --- </pre> <blockquote type="cite"> <pre class="qt-moz-quote-pre">command is described above under .Sx Flow-Control Constructs (if, while, for, case) . </pre> </blockquote> <pre class="qt-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 class="qt-moz-quote-pre">On 30/04/2026 12:47, <a class="qt-moz-txt-link-abbreviated moz-txt-link-freetext" href="mailto:alex@dawnmail.net" moz-do-not-send="true">alex@dawnmail.net</a> wrote: </pre> <blockquote type="cite"> <pre class="qt-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 class="qt-moz-quote-pre"><a class="qt-moz-txt-link-freetext moz-txt-link-freetext" href="https://github.com/freebsd/freebsd-src/blob/main/bin/sh/sh.1" moz-do-not-send="true">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> </blockquote> <div><br> </div> </blockquote> </body> </html>home | help
Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?93babe49-495d-4f81-83af-2be28ef71a37>