diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/acquire-additional-files.txt | 29 | ||||
| -rw-r--r-- | doc/apt-get.8.xml | 4 | ||||
| -rw-r--r-- | doc/apt-verbatim.ent | 2 | ||||
| -rw-r--r-- | doc/sources.list.5.xml | 13 |
4 files changed, 33 insertions, 15 deletions
diff --git a/doc/acquire-additional-files.txt b/doc/acquire-additional-files.txt index 68af9a5b0..c9bea068f 100644 --- a/doc/acquire-additional-files.txt +++ b/doc/acquire-additional-files.txt @@ -46,10 +46,11 @@ multiple types! After the type you can pick any valid and unique string which preferable refers to the file it downloads (In the example we picked 'Packages'). -This string is used as identifier for the target class and accessible as -'Created-By' e.g. in the "apt-get indextargets" output as detailed -below. It is also used to allow user to enable/disable targets per -sources.list entry. +This string is used as identifier (if not explicitly set otherwise) for +the target class and accessible as 'Identifier' and 'Created-By' e.g. +in the "apt-get indextargets" output as detailed below. The identifier +is also used to allow user to enable/disable targets per sources.list +entry. All targets have three main properties you can define: * MetaKey: The identifier of the file to be downloaded as used in the @@ -71,6 +72,12 @@ All targets have three main properties you can define: Additional optional properties: +* Identifier: The default value is the unique string identifying this + file (in the example above it was 'Packages') also accessible as + Created-By. The difference is that using this property multiple files + can be subsumed under one identifier e.g. if you configure multiple + possible locations for the files (with Fallback-Of), but the front-end + doesn't need to handle files from the different locations differently. * DefaultEnabled: The default value is 'yes' which means that apt will try to acquire this target from all sources. If set to 'no' the user has to explicitly enable this target in the sources.list file with the @@ -90,6 +97,11 @@ Additional optional properties: have to ensure your front-end can deal with all compressed fileformats supported by apt (libapt users can e.g. use FileFd, others can use the cat-file command of /usr/lib/apt/apt-helper). +* Fallback-Of: Is by default not set. If it is set and specifies another + target name (see Created-By) which was found in the Release file the + download of this target will be skipped. This can be used to implement + fallback(chain)s to allow transitions like the rename of target files. + The behavior if cycles are formed with Fallback-Of is undefined! * flat{MetaKey,Description}: APT supports two types of repositories: dists-style repositories which are the default and by far the most common which are named after the fact that the files are in an @@ -202,13 +214,13 @@ own output style. The variables are what you see in the output, just all uppercase and wrapped in $(), as in the configuration file. To get all the filenames of all Translation-en files you can e.g. call: - apt-get indextargets --format '$(FILENAME)' "Created-By: Translations" "Language: en" + apt-get indextargets --format '$(FILENAME)' "Identifier: Translations" "Language: en" -The line-based filtering and the formating is rather crude and feature- +The line-based filtering and the formatting is rather crude and feature- less by design: The default format is Debians standard format deb822 (in particular: Field names are case-insensitive and the order of fields in the stanza is undefined), so instead of apt reimplementing powerful -filters and formating for this command, it is recommend to use piping +filters and formatting for this command, it is recommend to use piping and dedicated tools like 'grep-dctrl' if you need more than the basics provided. @@ -241,6 +253,9 @@ Remarks on fields only available in (default) --release-info mode: Remarks on other available fields: * MetaKey, ShortDesc, Description, Site, Release: as defined by the configuration and described further above. +* Identifier: Defaults to the value of Created-By, but can be set + explicitly in the configuration (see above). Prefer this field over + Created-By to subsume multiple file(location)s (see Fallback-Of). * Created-By: configuration entity responsible for this target * Target-Of: type of the sources.list entry * URI, Repo-URI: avoid using. Contains potentially username/password. diff --git a/doc/apt-get.8.xml b/doc/apt-get.8.xml index 60fa46f97..a667a81da 100644 --- a/doc/apt-get.8.xml +++ b/doc/apt-get.8.xml @@ -249,8 +249,8 @@ working with APT to get information as well as filenames for downloaded files so they can use them as well instead of downloading them again on their own. Detailed documentation is - omitted here and can instead be found in the source tree in - <literal><filename>doc/acquire-additional-files.txt</filename></literal>. + omitted here and can instead be found in the file + &apt-acquire-additional-files; shipped by the <package>apt-doc</package> package. </para> </listitem> </varlistentry> diff --git a/doc/apt-verbatim.ent b/doc/apt-verbatim.ent index b4cc66dbd..9781ea2a6 100644 --- a/doc/apt-verbatim.ent +++ b/doc/apt-verbatim.ent @@ -196,6 +196,8 @@ </citerefentry>" > +<!ENTITY apt-acquire-additional-files "<literal><filename>/usr/share/doc/apt-doc/acquire-additional-files.txt</filename></literal>"> + <!-- Boiler plate docinfo section --> <!ENTITY apt-email " <address> diff --git a/doc/sources.list.5.xml b/doc/sources.list.5.xml index e8d88921d..f327e365b 100644 --- a/doc/sources.list.5.xml +++ b/doc/sources.list.5.xml @@ -222,10 +222,12 @@ deb-src [ option1=value1 option2=value2 ] uri suite [component1] [component2] [. (<option>target</option>) is a multivalue option defining which download targets apt will try to acquire from this source. If not specified, the default set is defined by the - <option>Acquire::IndexTargets</option> configuration scope. - Additionally, specific targets can be enabled or disabled by - using the identifier as field name instead of using this - multivalue option. + <option>Acquire::IndexTargets</option> configuration scope + (targets are specified by their name in the + <literal>Created-By</literal> field). + Additionally, targets can be enabled or disabled by using the + <literal>Identifier</literal> field as an option with a boolean + value instead of using this multivalue option. </para></listitem> <listitem><para><option>PDiffs</option> (<option>pdiffs</option>) @@ -501,8 +503,7 @@ Components: main contrib </refsect1> <refsect1><title>See Also</title> - <para>&apt-get;, &apt-conf; - </para> + <para>&apt-get;, &apt-conf;, &apt-acquire-additional-files;</para> </refsect1> &manbugs; |