Bug#809689: apt-ftparchive: please document all substitution variables in man page

[Martin-Éric Racine <martin-eric.racine@iki.fi>]

Package: apt-utils
Version: 1.0.9.8.1
Severity: important

apt-ftparchive's manual page needs a section to document which substitution variables are recognized. For instance:

TreeDefault {
         BinCacheDB "packages-$(SECTION)-$(ARCH).db";
          Directory "pool/$(SECTION)";
       SrcDirectory "pool/$(SECTION)";
           Packages "$(DIST)/$(SECTION)/binary-$(ARCH)/Packages";
            Sources "$(DIST)/$(SECTION)/source/Sources";
           Contents "$(DIST)/Contents-$(ARCH)";
};

This actually works but the manual page makes it sound as if those $(VARIABLES) are merely shown to explain the internals of apt-ftparchive.

It would thus be useful for the manual page to actually have a section that exastively lists all the recognized substitution variables.

-- System Information:
Debian Release: 8.2
  APT prefers stable
  APT policy: (1001, 'stable'), (1001, 'oldstable')
Architecture: i386 (i686)

Kernel: Linux 3.16.0-4-686-pae (SMP w/1 CPU core)
Locale: LANG=fi_FI.utf8, LC_CTYPE=fi_FI.utf8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)

Versions of packages apt-utils depends on:
ii  apt             1.0.9.8.1
ii  libapt-inst1.5  1.0.9.8.1
ii  libapt-pkg4.12  1.0.9.8.1
ii  libc6           2.19-18+deb8u1
ii  libdb5.3        5.3.28-9
ii  libgcc1         1:4.9.2-10
ii  libstdc++6      4.9.2-10

apt-utils recommends no packages.

apt-utils suggests no packages.

-- no debconf information