Bug#942756: cme: please provide more description of the format of d/fix.scanned.copyright

[Ross Vandegrift]

Package: cme
Version: 1.030-1
Severity: wishlist

Hello,

I started to use cme to maintain d/copyright today.  It'll be a big help, so
thanks!  But I ran into a few snags.

I'm not sure how d/fix.scanned.copyright is supposed to work.  Some examples in
Config::Model::Dpkg::Copyright(3pm) are clear but trivial.  They allude to some
complex capabilities without any explanation ("don't forget '!' to go back to
tree root": but what tree is there?  This is a text file with a few lines.)  I
think I need some more help from the point of view of someone trying to
automate management of d/copyright.

Things that I'd find helpful:
- what is the general form of these lines?  If that's too complex, examples
  covering more use-cases would be helpful.
- how should I handle stanzas with multiple lines in Files, Copyright, etc.?
- there appears to be a few ways to modify d/copyright stanzas.  What are the
  possibilities?

I found Config::Model::Loader(3pm) but it was overwhelming.  Documenting the
data structures doesn't help much since I'm not a perl programmer and I'd
rather avoid learning about the generic serialization described there.

Thanks,
Ross

-- System Information:
Debian Release: bullseye/sid
  APT prefers testing
  APT policy: (500, 'testing'), (40, 'unstable'), (30, 'experimental'), (1, 'experimental-debug')
Architecture: amd64 (x86_64)
Foreign Architectures: i386

Kernel: Linux 5.2.0-3-amd64 (SMP w/8 CPU cores)
Kernel taint flags: TAINT_OOT_MODULE, TAINT_UNSIGNED_MODULE
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8), LANGUAGE=en_US.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled

Versions of packages cme depends on:
ii  libapp-cmd-perl       0.331-1
ii  libconfig-model-perl  2.136-1
ii  libjson-perl          4.02000-1
ii  liblog-log4perl-perl  1.49-1
ii  libpath-tiny-perl     0.108-1
ii  libpod-pom-perl       2.01-3
ii  libyaml-perl          1.29-1
ii  perl                  5.28.1-6

Versions of packages cme recommends:
ii  libconfig-model-approx-perl   1.011-1
ii  libconfig-model-dpkg-perl     2.126
ii  libconfig-model-lcdproc-perl  2.052-2
ii  libconfig-model-openssh-perl  2.8.0.1-1
ii  libconfig-model-systemd-perl  0.240.1-1
ii  libconfig-model-tkui-perl     1.370-1

Versions of packages cme suggests:
pn  libconfig-model-cursesui-perl  <none>
pn  libconfig-model-itself-perl    <none>

-- no debconf information