rdmacm-utils: Missing man pages for cmtime and udpong

rdmacm-utils: Missing man pages for cmtime and udpong

[Benjamin Drung]

Hi,

the rdmacm-utils binaries cmtime and udpong do not have a corresponding
 man page. Please add some since Debian recommends to ship man pages
for all binaries.

-- 
Benjamin Drung
System Developer
Debian & Ubuntu Developer

ProfitBricks GmbH
Greifswalder Str. 207
D - 10405 Berlin

Email: benjamin.drung-EIkl63zCoXaH+58JC4qpiA@public.gmane.org
Web: https://www.profitbricks.com

Sitz der Gesellschaft: Berlin.
Registergericht: Amtsgericht Charlottenburg, HRB 125506B.
Geschäftsführer: Achim Weiss.

--
To unsubscribe from this list: send the line "unsubscribe linux-rdma" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: rdmacm-utils: Missing man pages for cmtime and udpong

[Leon Romanovsky]

[-- Attachment #1: Type: text/plain, Size: 899 bytes --]

On Mon, Apr 24, 2017 at 03:28:30PM +0200, Benjamin Drung wrote:
> Hi,
>
> the rdmacm-utils binaries cmtime and udpong do not have a corresponding
>  man page. Please add some since Debian recommends to ship man pages
> for all binaries.

Is it requirement or recommendation?

>
> --
> Benjamin Drung
> System Developer
> Debian & Ubuntu Developer
>
> ProfitBricks GmbH
> Greifswalder Str. 207
> D - 10405 Berlin
>
> Email: benjamin.drung-EIkl63zCoXaH+58JC4qpiA@public.gmane.org
> Web: https://www.profitbricks.com
>
> Sitz der Gesellschaft: Berlin.
> Registergericht: Amtsgericht Charlottenburg, HRB 125506B.
> Geschäftsführer: Achim Weiss.
>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-rdma" in
> the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: rdmacm-utils: Missing man pages for cmtime and udpong

[Benjamin Drung]

[-- Attachment #1: Type: text/plain, Size: 1428 bytes --]

Am Dienstag, den 25.04.2017, 21:04 +0300 schrieb Leon Romanovsky:
> On Mon, Apr 24, 2017 at 03:28:30PM +0200, Benjamin Drung wrote:
> > Hi,
> > 
> > the rdmacm-utils binaries cmtime and udpong do not have a
> > corresponding
> >  man page. Please add some since Debian recommends to ship man
> > pages
> > for all binaries.
> 
> Is it requirement or recommendation?

I looked it up. It's considered a bug. The Debian policy says in §12.1:

"Each program, utility, and function should have an associated manual
page included in the same package. It is suggested that all
configuration files also have a manual page included as well. Manual
pages for protocols and other auxiliary things are optional.

If no manual page is available, this is considered as a bug and should
be reported to the Debian Bug Tracking System (the maintainer of the
package is allowed to write this bug report themselves, if they so
desire). Do not close the bug report until a proper man page is
available."

See https://www.debian.org/doc/debian-policy/ch-docs.html

-- 
Benjamin Drung
System Developer
Debian & Ubuntu Developer

ProfitBricks GmbH
Greifswalder Str. 207
D - 10405 Berlin

Email: benjamin.drung-EIkl63zCoXaH+58JC4qpiA@public.gmane.org
Web: https://www.profitbricks.com

Sitz der Gesellschaft: Berlin.
Registergericht: Amtsgericht Charlottenburg, HRB 125506B.
Geschäftsführer: Achim Weiss.

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 801 bytes --]

Re: rdmacm-utils: Missing man pages for cmtime and udpong

[Leon Romanovsky]

[-- Attachment #1: Type: text/plain, Size: 1633 bytes --]

On Wed, Apr 26, 2017 at 11:22:42AM +0200, Benjamin Drung wrote:
> Am Dienstag, den 25.04.2017, 21:04 +0300 schrieb Leon Romanovsky:
> > On Mon, Apr 24, 2017 at 03:28:30PM +0200, Benjamin Drung wrote:
> > > Hi,
> > >
> > > the rdmacm-utils binaries cmtime and udpong do not have a
> > > corresponding
> > >  man page. Please add some since Debian recommends to ship man
> > > pages
> > > for all binaries.
> >
> > Is it requirement or recommendation?
>
> I looked it up. It's considered a bug. The Debian policy says in §12.1:

I understand, I just don't see many volunteers :( to write it.

>
> "Each program, utility, and function should have an associated manual
> page included in the same package. It is suggested that all
> configuration files also have a manual page included as well. Manual
> pages for protocols and other auxiliary things are optional.
>
> If no manual page is available, this is considered as a bug and should
> be reported to the Debian Bug Tracking System (the maintainer of the
> package is allowed to write this bug report themselves, if they so
> desire). Do not close the bug report until a proper man page is
> available."
>
> See https://www.debian.org/doc/debian-policy/ch-docs.html
>
> --
> Benjamin Drung
> System Developer
> Debian & Ubuntu Developer
>
> ProfitBricks GmbH
> Greifswalder Str. 207
> D - 10405 Berlin
>
> Email: benjamin.drung-EIkl63zCoXaH+58JC4qpiA@public.gmane.org
> Web: https://www.profitbricks.com
>
> Sitz der Gesellschaft: Berlin.
> Registergericht: Amtsgericht Charlottenburg, HRB 125506B.
> Geschäftsführer: Achim Weiss.



[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: rdmacm-utils: Missing man pages for cmtime and udpong

[Benjamin Drung]

[-- Attachment #1: Type: text/plain, Size: 1210 bytes --]

Am Donnerstag, den 27.04.2017, 07:00 +0300 schrieb Leon Romanovsky:
> On Wed, Apr 26, 2017 at 11:22:42AM +0200, Benjamin Drung wrote:
> > Am Dienstag, den 25.04.2017, 21:04 +0300 schrieb Leon Romanovsky:
> > > On Mon, Apr 24, 2017 at 03:28:30PM +0200, Benjamin Drung wrote:
> > > > Hi,
> > > > 
> > > > the rdmacm-utils binaries cmtime and udpong do not have a
> > > > corresponding
> > > >  man page. Please add some since Debian recommends to ship man
> > > > pages
> > > > for all binaries.
> > > 
> > > Is it requirement or recommendation?
> > 
> > I looked it up. It's considered a bug. The Debian policy says in
> > §12.1:
> 
> I understand, I just don't see many volunteers :( to write it.

Normally the authors of the program are in the best position to write
such a man page instead of the people from the distributions.

-- 
Benjamin Drung
System Developer
Debian & Ubuntu Developer

ProfitBricks GmbH
Greifswalder Str. 207
D - 10405 Berlin

Email: benjamin.drung-EIkl63zCoXaH+58JC4qpiA@public.gmane.org
Web: https://www.profitbricks.com

Sitz der Gesellschaft: Berlin.
Registergericht: Amtsgericht Charlottenburg, HRB 125506B.
Geschäftsführer: Achim Weiss.

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 801 bytes --]

Re: rdmacm-utils: Missing man pages for cmtime and udpong

[Hal Rosenstock]

On 4/28/2017 5:08 AM, Benjamin Drung wrote:
> Am Donnerstag, den 27.04.2017, 07:00 +0300 schrieb Leon Romanovsky:
>> On Wed, Apr 26, 2017 at 11:22:42AM +0200, Benjamin Drung wrote:
>>> Am Dienstag, den 25.04.2017, 21:04 +0300 schrieb Leon Romanovsky:
>>>> On Mon, Apr 24, 2017 at 03:28:30PM +0200, Benjamin Drung wrote:
>>>>> Hi,
>>>>>
>>>>> the rdmacm-utils binaries cmtime and udpong do not have a
>>>>> corresponding
>>>>>  man page. Please add some since Debian recommends to ship man
>>>>> pages
>>>>> for all binaries.
>>>>
>>>> Is it requirement or recommendation?
>>>
>>> I looked it up. It's considered a bug. The Debian policy says in
>>> §12.1:
>>
>> I understand, I just don't see many volunteers :( to write it.
> 
> Normally the authors of the program are in the best position to write
> such a man page instead of the people from the distributions.

There is now PR #124 in rdma-core github to resolve this. I've asked
Sean to review as he is the author of those examples.

-- Hal
--
To unsubscribe from this list: send the line "unsubscribe linux-rdma" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: rdmacm-utils: Missing man pages for cmtime and udpong

[Leon Romanovsky]

[-- Attachment #1: Type: text/plain, Size: 1288 bytes --]

On Fri, Apr 28, 2017 at 10:18:15AM -0400, Hal Rosenstock wrote:
> On 4/28/2017 5:08 AM, Benjamin Drung wrote:
> > Am Donnerstag, den 27.04.2017, 07:00 +0300 schrieb Leon Romanovsky:
> >> On Wed, Apr 26, 2017 at 11:22:42AM +0200, Benjamin Drung wrote:
> >>> Am Dienstag, den 25.04.2017, 21:04 +0300 schrieb Leon Romanovsky:
> >>>> On Mon, Apr 24, 2017 at 03:28:30PM +0200, Benjamin Drung wrote:
> >>>>> Hi,
> >>>>>
> >>>>> the rdmacm-utils binaries cmtime and udpong do not have a
> >>>>> corresponding
> >>>>>  man page. Please add some since Debian recommends to ship man
> >>>>> pages
> >>>>> for all binaries.
> >>>>
> >>>> Is it requirement or recommendation?
> >>>
> >>> I looked it up. It's considered a bug. The Debian policy says in
> >>> §12.1:
> >>
> >> I understand, I just don't see many volunteers :( to write it.
> >
> > Normally the authors of the program are in the best position to write
> > such a man page instead of the people from the distributions.
>
> There is now PR #124 in rdma-core github to resolve this. I've asked
> Sean to review as he is the author of those examples.

Thanks Hal for handling this.

Benjamin,

Do you see anything else in rdma-core which prevents us from being
accepted to Debian?

Thanks

>
> -- Hal

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]