diff mbox series

nfs-utils: nfsidmap.man: Fix section number

Message ID 20220412070016.720489-1-carnil@debian.org (mailing list archive)
State New
Headers show
Series nfs-utils: nfsidmap.man: Fix section number | expand

Commit Message

Salvatore Bonaccorso April 12, 2022, 7 a.m. UTC
From: Ben Hutchings <benh@debian.org>

The nfsidmap manual page is supposed to be in section 8, but calls the
.TH macro with a section argument of 5.  This results in an incorrect
header and causes debhelper (in Debian) to install it in the section 5
directory. Fix that.

Signed-off-by: Ben Hutchings <benh@debian.org>
[Salvatore Bonaccorso: Slightly modify commit message to mention that
the Problem is found in Debian through installing the manpage via
debhelper.]
Signed-off-by: Salvatore Bonaccorso <carnil@debian.org>
---
 utils/nfsidmap/nfsidmap.man | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Steve Dickson April 12, 2022, 2:28 p.m. UTC | #1
Hello,

On 4/12/22 3:00 AM, Salvatore Bonaccorso wrote:

My mailer was unable to process the attachment
Please in-line the patch and resend it.

steved.
Salvatore Bonaccorso April 12, 2022, 7:25 p.m. UTC | #2
Hi Steve,

On Tue, Apr 12, 2022 at 10:28:50AM -0400, Steve Dickson wrote:
> Hello,
> 
> On 4/12/22 3:00 AM, Salvatore Bonaccorso wrote:
> 
> My mailer was unable to process the attachment
> Please in-line the patch and resend it.

That is very strange, I used git send-email to submit it, and I do not
see where it got mangled, as it is present as well in

https://lore.kernel.org/linux-nfs/20220412070016.720489-1-carnil@debian.org/

Any idea what happened?

Here it is again, inlined in this message.

Regards,
Salvatore

From da390ced58885b0ed80be3722d4d913909e7c543 Mon Sep 17 00:00:00 2001
From: Ben Hutchings <benh@debian.org>
Date: Mon, 14 Mar 2022 00:19:33 +0100
Subject: [PATCH] nfsidmap.man: Fix section number

The nfsidmap manual page is supposed to be in section 8, but calls the
.TH macro with a section argument of 5.  This results in an incorrect
header and causes debhelper (in Debian) to install it in the section 5
directory. Fix that.

Signed-off-by: Ben Hutchings <benh@debian.org>
[Salvatore Bonaccorso: Slightly modify commit message to mention that
the Problem is found in Debian through installing the manpage via
debhelper]
Signed-off-by: Salvatore Bonaccorso <carnil@debian.org>
---
 utils/nfsidmap/nfsidmap.man | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/utils/nfsidmap/nfsidmap.man b/utils/nfsidmap/nfsidmap.man
index 2af16f3157ff..1911c41be6f9 100644
--- a/utils/nfsidmap/nfsidmap.man
+++ b/utils/nfsidmap/nfsidmap.man
@@ -2,7 +2,7 @@
 .\"@(#)nfsidmap(8) - The NFS idmapper upcall program
 .\"
 .\" Copyright (C) 2010 Bryan Schumaker <bjschuma@netapp.com>
-.TH nfsidmap 5 "1 October 2010"
+.TH nfsidmap 8 "1 October 2010"
 .SH NAME
 nfsidmap \- The NFS idmapper upcall program
 .SH SYNOPSIS
Salvatore Bonaccorso April 17, 2022, 8:21 a.m. UTC | #3
Hi Steve,

On Tue, Apr 12, 2022 at 09:25:28PM +0200, Salvatore Bonaccorso wrote:
> Hi Steve,
> 
> On Tue, Apr 12, 2022 at 10:28:50AM -0400, Steve Dickson wrote:
> > Hello,
> > 
> > On 4/12/22 3:00 AM, Salvatore Bonaccorso wrote:
> > 
> > My mailer was unable to process the attachment
> > Please in-line the patch and resend it.
> 
> That is very strange, I used git send-email to submit it, and I do not
> see where it got mangled, as it is present as well in
> 
> https://lore.kernel.org/linux-nfs/20220412070016.720489-1-carnil@debian.org/
> 
> Any idea what happened?
> 
> Here it is again, inlined in this message.
> 
> Regards,
> Salvatore
> 
> From da390ced58885b0ed80be3722d4d913909e7c543 Mon Sep 17 00:00:00 2001
> From: Ben Hutchings <benh@debian.org>
> Date: Mon, 14 Mar 2022 00:19:33 +0100
> Subject: [PATCH] nfsidmap.man: Fix section number
> 
> The nfsidmap manual page is supposed to be in section 8, but calls the
> .TH macro with a section argument of 5.  This results in an incorrect
> header and causes debhelper (in Debian) to install it in the section 5
> directory. Fix that.
> 
> Signed-off-by: Ben Hutchings <benh@debian.org>
> [Salvatore Bonaccorso: Slightly modify commit message to mention that
> the Problem is found in Debian through installing the manpage via
> debhelper]
> Signed-off-by: Salvatore Bonaccorso <carnil@debian.org>
> ---
>  utils/nfsidmap/nfsidmap.man | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/utils/nfsidmap/nfsidmap.man b/utils/nfsidmap/nfsidmap.man
> index 2af16f3157ff..1911c41be6f9 100644
> --- a/utils/nfsidmap/nfsidmap.man
> +++ b/utils/nfsidmap/nfsidmap.man
> @@ -2,7 +2,7 @@
>  .\"@(#)nfsidmap(8) - The NFS idmapper upcall program
>  .\"
>  .\" Copyright (C) 2010 Bryan Schumaker <bjschuma@netapp.com>
> -.TH nfsidmap 5 "1 October 2010"
> +.TH nfsidmap 8 "1 October 2010"
>  .SH NAME
>  nfsidmap \- The NFS idmapper upcall program
>  .SH SYNOPSIS
> -- 
> 2.35.1

Was this version now correctly processed by your mailer?

Regards,
Salvatore
Steve Dickson April 19, 2022, 7:17 p.m. UTC | #4
Hey!

Sorry for the delay...

On 4/17/22 4:21 AM, Salvatore Bonaccorso wrote:
> Hi Steve,
> 
> On Tue, Apr 12, 2022 at 09:25:28PM +0200, Salvatore Bonaccorso wrote:
>> Hi Steve,
>>
>> On Tue, Apr 12, 2022 at 10:28:50AM -0400, Steve Dickson wrote:
>>> Hello,
>>>
>>> On 4/12/22 3:00 AM, Salvatore Bonaccorso wrote:
>>>
>>> My mailer was unable to process the attachment
>>> Please in-line the patch and resend it.
>>
>> That is very strange, I used git send-email to submit it, and I do not
>> see where it got mangled, as it is present as well in
>>
>> https://lore.kernel.org/linux-nfs/20220412070016.720489-1-carnil@debian.org/
>>
>> Any idea what happened?
>>
>> Here it is again, inlined in this message.
>>
>> Regards,
>> Salvatore
>>
>>  From da390ced58885b0ed80be3722d4d913909e7c543 Mon Sep 17 00:00:00 2001
>> From: Ben Hutchings <benh@debian.org>
>> Date: Mon, 14 Mar 2022 00:19:33 +0100
>> Subject: [PATCH] nfsidmap.man: Fix section number
>>
>> The nfsidmap manual page is supposed to be in section 8, but calls the
>> .TH macro with a section argument of 5.  This results in an incorrect
>> header and causes debhelper (in Debian) to install it in the section 5
>> directory. Fix that.
>>
>> Signed-off-by: Ben Hutchings <benh@debian.org>
>> [Salvatore Bonaccorso: Slightly modify commit message to mention that
>> the Problem is found in Debian through installing the manpage via
>> debhelper]
>> Signed-off-by: Salvatore Bonaccorso <carnil@debian.org>
>> ---
>>   utils/nfsidmap/nfsidmap.man | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/utils/nfsidmap/nfsidmap.man b/utils/nfsidmap/nfsidmap.man
>> index 2af16f3157ff..1911c41be6f9 100644
>> --- a/utils/nfsidmap/nfsidmap.man
>> +++ b/utils/nfsidmap/nfsidmap.man
>> @@ -2,7 +2,7 @@
>>   .\"@(#)nfsidmap(8) - The NFS idmapper upcall program
>>   .\"
>>   .\" Copyright (C) 2010 Bryan Schumaker <bjschuma@netapp.com>
>> -.TH nfsidmap 5 "1 October 2010"
>> +.TH nfsidmap 8 "1 October 2010"
>>   .SH NAME
>>   nfsidmap \- The NFS idmapper upcall program
>>   .SH SYNOPSIS
>> -- 
>> 2.35.1
> 
> Was this version now correctly processed by your mailer?
Yeah I got it... thanks... but...
Are you saying that this man page should be in chapter 5
or it is fact Debian installs into chapter 5?

In RHEL and Fedora we install it in chapter 8... If it
belongs in a different chapter I have no problem changing
it... I just need to know why.

steved.


steved.
Salvatore Bonaccorso April 19, 2022, 7:56 p.m. UTC | #5
Hi Steve,

On Tue, Apr 19, 2022 at 03:17:45PM -0400, Steve Dickson wrote:
> Hey!
> 
> Sorry for the delay...
> 
> On 4/17/22 4:21 AM, Salvatore Bonaccorso wrote:
> > Hi Steve,
> > 
> > On Tue, Apr 12, 2022 at 09:25:28PM +0200, Salvatore Bonaccorso wrote:
> > > Hi Steve,
> > > 
> > > On Tue, Apr 12, 2022 at 10:28:50AM -0400, Steve Dickson wrote:
> > > > Hello,
> > > > 
> > > > On 4/12/22 3:00 AM, Salvatore Bonaccorso wrote:
> > > > 
> > > > My mailer was unable to process the attachment
> > > > Please in-line the patch and resend it.
> > > 
> > > That is very strange, I used git send-email to submit it, and I do not
> > > see where it got mangled, as it is present as well in
> > > 
> > > https://lore.kernel.org/linux-nfs/20220412070016.720489-1-carnil@debian.org/
> > > 
> > > Any idea what happened?
> > > 
> > > Here it is again, inlined in this message.
> > > 
> > > Regards,
> > > Salvatore
> > > 
> > >  From da390ced58885b0ed80be3722d4d913909e7c543 Mon Sep 17 00:00:00 2001
> > > From: Ben Hutchings <benh@debian.org>
> > > Date: Mon, 14 Mar 2022 00:19:33 +0100
> > > Subject: [PATCH] nfsidmap.man: Fix section number
> > > 
> > > The nfsidmap manual page is supposed to be in section 8, but calls the
> > > .TH macro with a section argument of 5.  This results in an incorrect
> > > header and causes debhelper (in Debian) to install it in the section 5
> > > directory. Fix that.
> > > 
> > > Signed-off-by: Ben Hutchings <benh@debian.org>
> > > [Salvatore Bonaccorso: Slightly modify commit message to mention that
> > > the Problem is found in Debian through installing the manpage via
> > > debhelper]
> > > Signed-off-by: Salvatore Bonaccorso <carnil@debian.org>
> > > ---
> > >   utils/nfsidmap/nfsidmap.man | 2 +-
> > >   1 file changed, 1 insertion(+), 1 deletion(-)
> > > 
> > > diff --git a/utils/nfsidmap/nfsidmap.man b/utils/nfsidmap/nfsidmap.man
> > > index 2af16f3157ff..1911c41be6f9 100644
> > > --- a/utils/nfsidmap/nfsidmap.man
> > > +++ b/utils/nfsidmap/nfsidmap.man
> > > @@ -2,7 +2,7 @@
> > >   .\"@(#)nfsidmap(8) - The NFS idmapper upcall program
> > >   .\"
> > >   .\" Copyright (C) 2010 Bryan Schumaker <bjschuma@netapp.com>
> > > -.TH nfsidmap 5 "1 October 2010"
> > > +.TH nfsidmap 8 "1 October 2010"
> > >   .SH NAME
> > >   nfsidmap \- The NFS idmapper upcall program
> > >   .SH SYNOPSIS
> > > -- 
> > > 2.35.1
> > 
> > Was this version now correctly processed by your mailer?
> Yeah I got it... thanks... but...
> Are you saying that this man page should be in chapter 5
> or it is fact Debian installs into chapter 5?
> 
> In RHEL and Fedora we install it in chapter 8... If it
> belongs in a different chapter I have no problem changing
> it... I just need to know why.

Apologies, so this was apparently not very clear. That it belongs into
section 8 is right. Debian installed it into the wrong section because
the section in the manpage itself refers to 5. This is what the patch
tries to inline, and fix the wrong argument to the .TH macro.

Because the manpage incorrectly calls the .TH macro with a section
argument of 5 the debhelper program in Debian installs the manpage
into section 5.

Does this clarifies?

Regards,
Salvatore
Steve Dickson April 19, 2022, 8:39 p.m. UTC | #6
On 4/19/22 3:56 PM, Salvatore Bonaccorso wrote:
> Hi Steve,
> 
> On Tue, Apr 19, 2022 at 03:17:45PM -0400, Steve Dickson wrote:
>> Hey!
>>
>> Sorry for the delay...
>>
>> On 4/17/22 4:21 AM, Salvatore Bonaccorso wrote:
>>> Hi Steve,
>>>
>>> On Tue, Apr 12, 2022 at 09:25:28PM +0200, Salvatore Bonaccorso wrote:
>>>> Hi Steve,
>>>>
>>>> On Tue, Apr 12, 2022 at 10:28:50AM -0400, Steve Dickson wrote:
>>>>> Hello,
>>>>>
>>>>> On 4/12/22 3:00 AM, Salvatore Bonaccorso wrote:
>>>>>
>>>>> My mailer was unable to process the attachment
>>>>> Please in-line the patch and resend it.
>>>>
>>>> That is very strange, I used git send-email to submit it, and I do not
>>>> see where it got mangled, as it is present as well in
>>>>
>>>> https://lore.kernel.org/linux-nfs/20220412070016.720489-1-carnil@debian.org/
>>>>
>>>> Any idea what happened?
>>>>
>>>> Here it is again, inlined in this message.
>>>>
>>>> Regards,
>>>> Salvatore
>>>>
>>>>   From da390ced58885b0ed80be3722d4d913909e7c543 Mon Sep 17 00:00:00 2001
>>>> From: Ben Hutchings <benh@debian.org>
>>>> Date: Mon, 14 Mar 2022 00:19:33 +0100
>>>> Subject: [PATCH] nfsidmap.man: Fix section number
>>>>
>>>> The nfsidmap manual page is supposed to be in section 8, but calls the
>>>> .TH macro with a section argument of 5.  This results in an incorrect
>>>> header and causes debhelper (in Debian) to install it in the section 5
>>>> directory. Fix that.
>>>>
>>>> Signed-off-by: Ben Hutchings <benh@debian.org>
>>>> [Salvatore Bonaccorso: Slightly modify commit message to mention that
>>>> the Problem is found in Debian through installing the manpage via
>>>> debhelper]
>>>> Signed-off-by: Salvatore Bonaccorso <carnil@debian.org>
>>>> ---
>>>>    utils/nfsidmap/nfsidmap.man | 2 +-
>>>>    1 file changed, 1 insertion(+), 1 deletion(-)
>>>>
>>>> diff --git a/utils/nfsidmap/nfsidmap.man b/utils/nfsidmap/nfsidmap.man
>>>> index 2af16f3157ff..1911c41be6f9 100644
>>>> --- a/utils/nfsidmap/nfsidmap.man
>>>> +++ b/utils/nfsidmap/nfsidmap.man
>>>> @@ -2,7 +2,7 @@
>>>>    .\"@(#)nfsidmap(8) - The NFS idmapper upcall program
>>>>    .\"
>>>>    .\" Copyright (C) 2010 Bryan Schumaker <bjschuma@netapp.com>
>>>> -.TH nfsidmap 5 "1 October 2010"
>>>> +.TH nfsidmap 8 "1 October 2010"
>>>>    .SH NAME
>>>>    nfsidmap \- The NFS idmapper upcall program
>>>>    .SH SYNOPSIS
>>>> -- 
>>>> 2.35.1
>>>
>>> Was this version now correctly processed by your mailer?
>> Yeah I got it... thanks... but...
>> Are you saying that this man page should be in chapter 5
>> or it is fact Debian installs into chapter 5?
>>
>> In RHEL and Fedora we install it in chapter 8... If it
>> belongs in a different chapter I have no problem changing
>> it... I just need to know why.
> 
> Apologies, so this was apparently not very clear. That it belongs into
> section 8 is right. Debian installed it into the wrong section because
> the section in the manpage itself refers to 5. This is what the patch
> tries to inline, and fix the wrong argument to the .TH macro.
> 
> Because the manpage incorrectly calls the .TH macro with a section
> argument of 5 the debhelper program in Debian installs the manpage
> into section 5.
> 
> Does this clarifies?Yes it does... Thank you!

Committed... (re-tagged: nfs-utils-2-6-2-rc4)

steved.
diff mbox series

Patch

diff --git a/utils/nfsidmap/nfsidmap.man b/utils/nfsidmap/nfsidmap.man
index 2af16f3157ff..1911c41be6f9 100644
--- a/utils/nfsidmap/nfsidmap.man
+++ b/utils/nfsidmap/nfsidmap.man
@@ -2,7 +2,7 @@ 
 .\"@(#)nfsidmap(8) - The NFS idmapper upcall program
 .\"
 .\" Copyright (C) 2010 Bryan Schumaker <bjschuma@netapp.com>
-.TH nfsidmap 5 "1 October 2010"
+.TH nfsidmap 8 "1 October 2010"
 .SH NAME
 nfsidmap \- The NFS idmapper upcall program
 .SH SYNOPSIS