Skip to contentSkip to conversation

rdmacm-utils: Missing man pages for cmtime and udpong

DISCUSSION Benjamin Drung 3 participants 7 messages Apr 24, 2017 – Apr 30, 2017 6 messages not in the archive InfiniBand

lore
Share & tools
lore
#0 lore raw

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.

Signature · 19 lines
Benjamin Drung
System Developer
Debian & Ubuntu Developer

ProfitBricks GmbH
Greifswalder Str. 207
D - 10405 Berlin

Email: [email protected]
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 [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

A message that is not in the archive (sent off-list or not yet received): [email protected]

#2 lore raw
Quoted 5 lines · 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.

Is it requirement or recommendation?

Quoted 21 lines

--
Benjamin Drung
System Developer
Debian & Ubuntu Developer

ProfitBricks GmbH
Greifswalder Str. 207
D - 10405 Berlin

Email: [email protected] 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 [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html

A message that is not in the archive (sent off-list or not yet received): 20170425180423.GT14088-U/[email protected]

#4 lore raw

Am Dienstag, den 25.04.2017, 21:04 +0300 schrieb Leon Romanovsky:

Quoted 10 lines · Benjamin Drung
Quoted 7 lines

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

Signature · 14 lines
Benjamin Drung
System Developer
Debian & Ubuntu Developer

ProfitBricks GmbH
Greifswalder Str. 207
D - 10405 Berlin

Email: [email protected]
Web: https://www.profitbricks.com

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

A message that is not in the archive (sent off-list or not yet received): [email protected]

#6 lore raw
Quoted 10 lines · Benjamin Drung

Am Dienstag, den 25.04.2017, 21:04 +0300 schrieb Leon Romanovsky:

Quoted 9 lines · Benjamin Drung
Quoted 7 lines

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.

Quoted 3 lines
Quoted 1 line

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.

Quoted 29 lines

"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: [email protected] Web: https://www.profitbricks.com

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

A message that is not in the archive (sent off-list or not yet received): 20170427040018.GY14088-U/[email protected]

#8 lore raw

Am Donnerstag, den 27.04.2017, 07:00 +0300 schrieb Leon Romanovsky:

Quoted 11 lines · Benjamin Drung
Quoted 10 lines

Am Dienstag, den 25.04.2017, 21:04 +0300 schrieb Leon Romanovsky:

Quoted 9 lines · Benjamin Drung
Quoted 7 lines

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.

Quoted 6 lines
Quoted 4 lines
Quoted 1 line

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.

Signature · 14 lines
Benjamin Drung
System Developer
Debian & Ubuntu Developer

ProfitBricks GmbH
Greifswalder Str. 207
D - 10405 Berlin

Email: [email protected]
Web: https://www.profitbricks.com

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

A message that is not in the archive (sent off-list or not yet received): [email protected]

#10 lore raw
Quoted 14 lines · Benjamin Drung

Am Donnerstag, den 27.04.2017, 07:00 +0300 schrieb Leon Romanovsky:

Quoted 13 lines · Benjamin Drung
Quoted 12 lines

Am Dienstag, den 25.04.2017, 21:04 +0300 schrieb Leon Romanovsky:

Quoted 10 lines · Benjamin Drung
Quoted 7 lines

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?

Quoted 7 lines
Quoted 4 lines
Quoted 2 lines

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 [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html

A message that is not in the archive (sent off-list or not yet received): 550f6e6a-931a-0aba-2d54-1ca1b3a44150-LDSdmyG8hGV8YrgS2mwiifqBs+8SCbDb@public.gmane.org

#12 lore raw
Quoted 18 lines · Hal Rosenstock
Quoted 17 lines · Benjamin Drung

Am Donnerstag, den 27.04.2017, 07:00 +0300 schrieb Leon Romanovsky:

Quoted 16 lines · Benjamin Drung
Quoted 14 lines

Am Dienstag, den 25.04.2017, 21:04 +0300 schrieb Leon Romanovsky:

Quoted 10 lines · Benjamin Drung
Quoted 7 lines

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:

Quoted 7 lines
Quoted 4 lines
Quoted 1 line

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

Quoted 2 lines

-- Hal