From 1a3a14ac63b0c4f18de53a7bddcf79d20a5e814f Mon Sep 17 00:00:00 2001
From: David Kalnischkies <david@kalnischkies.de>
Date: Thu, 27 Aug 2015 18:13:00 +0200
Subject: sources.list and indextargets option for pdiffs

Disabling pdiffs can be useful occasionally, like if you have a fast
local mirror where the download doesn't matter, but still want to use it
for non-local mirrors. Also, some users might prefer it to only use it
for very big indextargets like Contents.
---
 doc/acquire-additional-files.txt | 10 +++++++++-
 doc/apt.conf.5.xml               |  6 ++++--
 doc/sources.list.5.xml           | 14 ++++++++++++++
 3 files changed, 27 insertions(+), 3 deletions(-)

(limited to 'doc')

diff --git a/doc/acquire-additional-files.txt b/doc/acquire-additional-files.txt
index 71ce7b0cb..9110bfe79 100644
--- a/doc/acquire-additional-files.txt
+++ b/doc/acquire-additional-files.txt
@@ -85,7 +85,15 @@ file if it is available and uncompress it for you, just as it will also
 use pdiff patching if provided by the repository and enabled by the
 user. You only have to ensure that the Release file contains the
 information about the compressed files/pdiffs to make this happen.
-NO properties have to be set to enable this.
+*NO* properties have to be set to enable this!
+
+
+Additional properties exist, but these should *NOT* be set by frontends
+requesting files. They exist for internal and end-user usage only:
+* PDiffs: controls if apt will try to use pdiffs for this target.
+  Defaults to the value of Acquire::PDiffs which is true by default.
+  Can be overridden per-source by the sources.list option of the same
+  name. See the documentation for both of these for details.
 
 # More examples
 
diff --git a/doc/apt.conf.5.xml b/doc/apt.conf.5.xml
index 920b42ba1..62dffadc4 100644
--- a/doc/apt.conf.5.xml
+++ b/doc/apt.conf.5.xml
@@ -334,8 +334,10 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
 
      <varlistentry><term><option>PDiffs</option></term>
 	 <listitem><para>Try to download deltas called <literal>PDiffs</literal> for
-	 indexes (like <filename>Packages</filename> files) instead of downloading
-	 whole ones. True by default.</para>
+	 indexes (like <filename>Packages</filename> files) instead of
+	 downloading whole ones. True by default. Preferably, this can be set
+	 for specific &sources-list; entries or index files by using the
+	 <option>PDiffs</option> option there.</para>
 	 <para>Two sub-options to limit the use of PDiffs are also available:
 	 <literal>FileLimit</literal> can be used to specify a maximum number of
 	 PDiff files should be downloaded to update a file. <literal>SizeLimit</literal>
diff --git a/doc/sources.list.5.xml b/doc/sources.list.5.xml
index 4eb3c0ba0..cfd98e545 100644
--- a/doc/sources.list.5.xml
+++ b/doc/sources.list.5.xml
@@ -226,6 +226,20 @@ deb-src [ option1=value1 option2=value2 ] uri suite [component1] [component2] [.
 		using the identifier as field name instead of using this
 		multivalue option.
 	  </para></listitem>
+
+	  <listitem><para><option>PDiffs</option> (<option>pdiffs</option>)
+		is a yes/no value which controls if APT should try to use PDiffs
+		to update old indexes instead of downloading the new indexes
+		entirely. The value of this option is ignored if the repository
+		doesn't announce the availability of PDiffs.  Defaults to the
+		value of the option with the same name for a specific index file
+		defined in the <option>Acquire::IndexTargets</option> scope,
+		which itself default to the value of configuration option
+		<option>Acquire::PDiffs</option> which defaults to
+		<literal>yes</literal>.
+	  </para></listitem>
+
+
        </itemizedlist>
 
        Further more, there are options which if set effect
-- 
cgit v1.2.3