Hi

On Fri, Jan 20, 2017 at 12:14:04AM +0200, Joonas Kylmälä wrote:
> Package: maint-guide
> Version: 1.2.37
> Severity: wishlist
> 
> Hi,
> 
> Chapter 5.7. "docs" has this paragraph:
> 
> "By default, it will include all existing files in the top-level
> source directory that are called BUGS, README*, TODO etc."
> 
> It is hard to understand if by "it" is meant the dh_installdocs or
> dh_make program (dh_make I guess, after reading some source code :P).

"it" == "this file"

I thought it is clear since the previous paragraph's subject is "this file".
(Excuse me for my English quality in general ... I am Japanese.)

> I'm hoping that someone who knows what is meant here could clarify the
> document (e.g. something like in chapter 5.1. where it is explicitly
> mentioned that the file came from dh_make).

If I go more details;

This file with the help of the debhelper tool chain properly set up by
the dh_make command will invoke the dh_installdocs command to include
all existing files in the top-level source directory that are called
BUGS, README*, TODO etc.

I am not so thrilled to go this deep just for here.  Changing words
breaks translations.

Besides, I have rewitten recently with simplified explanation covering
moden things at:
  https://www.debian.org/doc/manuals/debmake-doc
  https://www.debian.org/doc/manuals/debmake-doc/ch05.en.html#debianconf

For "docs", I simply state

| binarypackage.docs 
|   List documentation files to be installed in binarypackage.
| 
|   See dh_installdocs(1).

It's better to leave such details to the right document and this kind of
tutorial to stay just with the pointer.

Regards,

Osamu

Reply via email to