Bug#804783: libconfig-model-dpkg-perl: No documentation of fill.copyright.blanks.yml

[Dominique Dumont]

Hello

Sorry for the very late reply. I've been side tracked by perl6 packaging
and other issues ...

On Wed, 11 Nov 2015 15:52:55 +0100 Jens Reyer <jre.winesim at gmail.com> wrote:
> using scan-copyrights I get output like this for some files:
> 
> Path debian/copyright.new has no license info. Add a line in
> debian/fill.copyright.blank file
> 
> 1.)
> This is misleading, the correct filepath is
> debian/fill.copyright.blanks.yml. Attached patch fixes this, a
> redundancy in the output when loading this file, and a capitalization error.

You're right. Applied.

> 2.)
> You already have documented this feature in
> lib/Dpkg/Copyright/Scanner.pm, but this is not available in man
> scan-copyrights. I didn't want to dive into the whole
> buildsystem/perl/whatever, so no patch here.

This issue is difficult to deal with without duplicating information..

I've modified scan-copyright man page to mention fill.copyright.blanks.yml file
and refer to Dpkg::Copyright::Scanner man page so user can get more details [1].

The command "cme update dpkg-copyright" has a similar issue. Both cme and
App::Cme::Command::update are generic component. So their doc cannot mention 
fill.copyright.blanks.yml which is specific to Dpkg::Copyright...
(generic code and plugins are great for re-use but are a nightmare to document ...)

So I've tweaked Config::Model::Dpkg::Copyright to print on STDOUT at the end of all 
the output that result can be improved and refer to the relevant doc in 
Config::Model::Dpkg::Copyright man page, which also refer to the doc in 
Dpkg::Copyright::Scanner:

    Please follow the instructions given in Config::Model::Dpkg::Copyright man page,
    section "Tweak results" if some license and copyright entries are wrong. 
    Other information, like license text, can be added directly in debian/copyright file.
    This information will be merged correctly next time this command is run.

I can't say I'm happy with this solution, but I currently have no better idea...

> Thanks a lot. This is the first time I use scan-copyrights, but I really
> like it.

Thanks for the feedback.

And thanks for the report: as the developer of this code, I seldom notice 
documentation issues like this one. User's help in this case in invaluable.

All the best.

[1] https://anonscm.debian.org/cgit/pkg-perl/packages/libconfig-model-dpkg-perl.git/commit/?id=18c21b1dfda135cc81411f7026dc798de6641b47

-- 
 https://github.com/dod38fr/   -o- http://search.cpan.org/~ddumont/
http://ddumont.wordpress.com/  -o-   irc: dod at irc.debian.org