On 6/27/07, Joey Hess <[EMAIL PROTECTED]> wrote:
Martin-Éric Racine wrote:
> For NEWS, README and TODO files, the current behavior varies depending on
> whether the files reside in the upstream tarball or in the debian/ directory.
>
> For the upstream files, dh_installdocs successfully catches everything it
finds.
> For the debian/ directory content, some files must explicitely have a .Debian
> extension while other files get it appended automatically by dh_installdocs.
> For instance, it currently is that debian/README won't be automatically found,
> but debian/README.Debian will be. In contradiction, debian/NEWS is found and
> automatically renamed to NEWS.Debian, while debian/NEWS.Debian will be missed.
dh_installdocs does not do anything with NEWS files. These are handled
by dh_installchanglogs in a manner completely symmetric with how
debian/changelogs is handled. It would make no more sense for
dh_installchangelogs to look for debian/NEWS.Debian than it would for it
to look for debian/changelog.Debian -- those are not the filenames that
Debian tools such as dch use when modifying or reading these files.
> It would be desirable for this behavior to become consistant.
>
> What I propose is that the helper should catch any occurance of
NEWS|README|TODO
> inside the debian/ directory, adding the .Debian extension if found missing.
It might be possible to get dh_installdocs to look for debian/README and
debian/TODO.Debian, although I'm not sure what to do:
- if both a debian/README.Debian and a debian/REAMDE exist
Both cannot exist. Report an error if that happens.
- about packages that include a debian/README without intending it to
be included in the binary package (since it's currently not)
Anything that is not meant for inclusion should go into e.g.
debian/INSTALL which remains consistent with any upstream INSTALL not
being included in a binary.
The overall idea is that all occurrences of debian/[NEWS|README|TODO]
be included in the binary and renamed [NEWS|README|TODO].Debian, which
would finally apply a consistent behavior for all of those CAPS
documentation files.
As a transitional measure, debhelpers could report a warning if any of
the above files are
already have the .Debian extension or if both exist.
--
Martin-Éric Racine
http://q-funk.iki.fi
