Re: 1.2.1. FreeBSD installation process

Benedict,

Attached is the new mdoc file sh4.1.

$ freebsd-version
15.0-RELEASE-p5
$

I changed line 2380:
.Bl -offset indent
to:
.Bl -item -offset indent
in order to fix the following error which unrelated to my change:
$ mandoc -T lint ./sh.1
mandoc: ./sh.1:2376:2: ERROR: missing list type, using -item: Bl
$ 

sh4.1 has the original line along with the updated date on line 34.
Please let me know if it's working.

Thanks,
Alex




On Sat, May 2, 2026, at 2:12 PM, Benedict Reuschling wrote:
> 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 [email protected]:
>> 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/
>>> 
>>> Thank you!
>>> 
>>> Regards,
>>> Benedict 
>>> 
>>> Am 01.05.26 um 05:31 schrieb [email protected]:
>>>> 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, [email protected] 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
>>