From 57a00c50b14a49ed91816e3f4467e0f2e57ee772 Mon Sep 17 00:00:00 2001
From: David Kalnischkies <david@kalnischkies.de>
Date: Tue, 27 Feb 2018 18:05:10 +0100
Subject: mention mirror method in sources.list

Closes: 679580
---
 doc/apt-verbatim.ent   |  6 ++++++
 doc/sources.list.5.xml | 11 +++++++++++
 2 files changed, 17 insertions(+)

(limited to 'doc')

diff --git a/doc/apt-verbatim.ent b/doc/apt-verbatim.ent
index d7817cb79..a8aa0bf5e 100644
--- a/doc/apt-verbatim.ent
+++ b/doc/apt-verbatim.ent
@@ -93,6 +93,12 @@
   </citerefentry>"
 >
 
+<!ENTITY apt-transport-mirror "<citerefentry>
+    <refentrytitle><command>apt-transport-mirror</command></refentrytitle>
+    <manvolnum>1</manvolnum>
+  </citerefentry>"
+>
+
 <!ENTITY sources-list "<citerefentry>
     <refentrytitle><filename>sources.list</filename></refentrytitle>
     <manvolnum>5</manvolnum>
diff --git a/doc/sources.list.5.xml b/doc/sources.list.5.xml
index 75b5d94b9..e55c5b31e 100644
--- a/doc/sources.list.5.xml
+++ b/doc/sources.list.5.xml
@@ -409,6 +409,17 @@ deb-src [ option1=value1 option2=value2 ] uri suite [component1] [component2] [.
     alternative.</para></listitem>
     </varlistentry>
 
+    <varlistentry><term><command>mirror</command>, <command>mirror+<replaceable>scheme</replaceable></command> (&apt-transport-mirror;)</term>
+    <listitem><para>
+    The mirror scheme specifies the location of a mirrorlist. By default the
+    scheme used for the location is <literal>http</literal>, but any other
+    scheme can be used via <command>mirror+<replaceable>scheme</replaceable></command>.
+    The mirrorlist itself can contain many different URIs for mirrors the APT client
+    can transparently pick, choose and fallback between intended to help both
+    with distributing the load over the available mirrors and ensuring that
+    clients can acquire data even if some configured mirrors are not available.
+    </para></listitem>
+    </varlistentry>
 
     <varlistentry><term><command>file</command></term>
     <listitem><para>
-- 
cgit v1.2.3