public inbox for gentoo-commits@lists.gentoo.org
 help / color / mirror / Atom feed
From: "Brian Evans" <grknight@gentoo.org>
To: gentoo-commits@lists.gentoo.org
Subject: [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/variables/
Date: Tue, 19 Mar 2019 17:11:22 +0000 (UTC)	[thread overview]
Message-ID: <1553014924.6ecbc55422bfd78865e16f077672357b3b321b34.grknight@gentoo> (raw)

commit:     6ecbc55422bfd78865e16f077672357b3b321b34
Author:     Michael Orlitzky <mjo <AT> gentoo <DOT> org>
AuthorDate: Sat Oct 28 01:43:46 2017 +0000
Commit:     Brian Evans <grknight <AT> gentoo <DOT> org>
CommitDate: Tue Mar 19 17:02:04 2019 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6ecbc554

ebuild-writing/variables: document the mirror:// pseudo-protocol.

The thirdpartymirrors file is covered by the PMS, but unless you know
where to look, it's not easy to figure out what "mirror://" does in
SRC_URI. This commit adds a mention of the file and protocol under the
"SRC_URI" heading on the "Variables" page.

Signed-off-by: Michael Orlitzky <mjo <AT> gentoo.org>
Signed-off-by: Brian Evans <grknight <AT> gentoo.org>

 ebuild-writing/variables/text.xml | 44 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/ebuild-writing/variables/text.xml b/ebuild-writing/variables/text.xml
index 98babe4..d3255bd 100644
--- a/ebuild-writing/variables/text.xml
+++ b/ebuild-writing/variables/text.xml
@@ -414,6 +414,50 @@ SRC_URI="https://example.com/files/${PV}.tar.gz -> ${P}.tar.gz"
 
 </body>
 </subsection>
+
+
+<subsection>
+  <title>Third-party mirrors</title>
+  <body>
+    <p>
+      If the items in <c>SRC_URI</c> are available on multiple
+      third-party mirrors, then you don't have to list each mirror in
+      your ebuild. The <c>profiles/thirdpartymirrors</c> file in the
+      <c>::gentoo</c> repository contains named groups of mirrors,
+      accessible through the <c>mirror://</c> pseudo-protocol.
+    </p>
+    <p>
+      As of EAPI 7, the format of <uri
+      link="https://projects.gentoo.org/pms/7/pms.html#x1-340004.4.2">the
+      thirdpartymirrors file</uri> is described in section 4.4.2 of
+      the Package Manager Specification (PMS). One might define a set
+      of &quot;example&quot; mirrors,
+    </p>
+<!--
+  The following isn't ebuild code, but lang="ebuild" works, and no
+  other language choice would be accurate either.
+-->
+<codesample lang="ebuild">
+example http://download.example.org/ ftp://ftp.example.org/
+</codesample>
+    <p>
+      that can afterwards be referenced through a <c>mirror://</c>
+      URL:
+    </p>
+<codesample lang="ebuild">
+SRC_URI="mirror://example/${PN}/${P}.tar.gz"
+</codesample>
+    <warning>
+      If the sources for a package are not mirror-restricted or
+      fetch-restricted, then there is little benefit to using this
+      feature: the sources will be <uri
+      link="::general-concepts/mirrors">mirrored onto Gentoo
+      infrastructure</uri> anyway. In other words, the mere existence
+      of a third-party mirror list is not a good enough reason to use
+      it.
+    </warning>
+  </body>
+</subsection>
 </section>
 
 <section>


             reply	other threads:[~2019-03-19 17:11 UTC|newest]

Thread overview: 57+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-19 17:11 Brian Evans [this message]
  -- strict thread matches above, loose matches on Subject: below --
2025-09-20 13:24 [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/variables/ Sam James
2025-08-03 13:01 James Le Cuirot
2025-08-03 13:01 James Le Cuirot
2025-07-22 22:25 James Le Cuirot
2025-07-22 22:25 James Le Cuirot
2022-08-25 16:42 Ulrich Müller
2022-08-25 16:42 Ulrich Müller
2022-08-25 16:42 Ulrich Müller
2022-02-18 18:19 Sam James
2022-02-16 18:43 Ulrich Müller
2022-02-16 18:02 Matthew Smith
2021-05-28 13:09 Ulrich Müller
2021-03-30  7:21 Ulrich Müller
2021-03-30  7:21 Ulrich Müller
2021-03-30  7:21 Ulrich Müller
2021-03-30  7:21 Ulrich Müller
2021-03-30  7:21 Ulrich Müller
2021-03-26 19:05 Ulrich Müller
2020-03-11 14:38 Ulrich Müller
2019-11-29  9:28 Ulrich Müller
2019-11-28 18:32 Göktürk Yüksek
2019-11-28 18:32 Göktürk Yüksek
2019-11-26  1:49 Göktürk Yüksek
2019-11-26  1:49 Göktürk Yüksek
2019-10-16 20:16 Göktürk Yüksek
2019-10-16 20:16 Göktürk Yüksek
2019-10-16 20:16 Göktürk Yüksek
2019-10-16 20:16 Göktürk Yüksek
2019-10-16 20:16 Göktürk Yüksek
2019-10-16 20:16 Göktürk Yüksek
2019-10-16 20:16 Göktürk Yüksek
2019-10-16 20:16 Göktürk Yüksek
2019-05-22 19:40 Göktürk Yüksek
2019-03-24 16:48 Ulrich Müller
2019-03-19 17:11 Brian Evans
2018-10-24 13:01 Brian Evans
2018-10-24 13:01 Brian Evans
2017-11-12 20:15 Ulrich Müller
2017-09-09  3:43 Göktürk Yüksek
2016-12-07 19:46 Göktürk Yüksek
2016-11-17  5:23 Göktürk Yüksek
2016-10-28 14:21 Göktürk Yüksek
2016-10-28 14:21 Göktürk Yüksek
2016-07-13  3:18 Göktürk Yüksek
2016-07-13  2:48 Göktürk Yüksek
2016-05-20  6:23 Göktürk Yüksek
2016-05-18  6:56 Göktürk Yüksek
2016-05-11  1:43 Mike Gilbert
2016-05-04  9:13 Göktürk Yüksek
2015-12-08 20:06 Ulrich Müller
2015-08-07  5:08 Mike Frysinger
2013-05-15 13:39 Dirkjan Ochtman
2013-05-15 13:39 Dirkjan Ochtman
2013-05-15 13:17 Dirkjan Ochtman
2012-11-24 19:12 Ulrich Mueller
2012-11-11 19:33 Markos Chandras

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1553014924.6ecbc55422bfd78865e16f077672357b3b321b34.grknight@gentoo \
    --to=grknight@gentoo.org \
    --cc=gentoo-commits@lists.gentoo.org \
    --cc=gentoo-dev@lists.gentoo.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox