#855531 debhelper: include common options in all manpages

Package:
src:debhelper
Source:
debhelper
Submitter:
Michael Gilbert
Date:
2025-03-29 06:09:07 UTC
Severity:
wishlist
Tags:
#855531#5
Date:
2017-02-19 20:55:55 UTC
From:
To:
package: src:debhelper
severity: wishlist

Options that are common to all of the debhelper commands are only
documented in the debhelper.7 manpage.

It could be helpful and clearer to add that information also to the
manpages for individual commands, like dh_strip.1.

Best wishes,
Mike

#855531#10
Date:
2018-05-19 11:07:00 UTC
From:
To:
Control: tags -1 help newcomer

Hi,

I can appreciate why this would be useful.

However, at the same time, I do not want to manually
maintain/synchronize 60+ copies of the same text pieces if I can avoid it.

I will accept patches that injects the text into each helper at build
time.  Please keep in mind that:

 * The option description are translatable today and must remain so
   after the patch.

 * I am fine with moving the master copy of the options out of
   debhelper.pod if that makes things easier.  However, all of the
   common/shared options must still be documented in the generated
   debhelper(7).

 * The update of documentation must happen automatically at build time.

 * Not all helpers do something useful on all shared/common options.
   E.g. not helpers use -X or --ignore (but will silently accept it).
   It *may* make sense to choose what options are injected instead of
   injecting all options.

I am also happy to help a newcomer work on this, who would be interested
in contributing to debhelper or Debian.

Thanks,
~Niels