summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichał Górny <mgorny@gentoo.org>2016-07-26 17:41:27 +0200
committerMichał Górny <mgorny@gentoo.org>2016-07-26 17:43:53 +0200
commit2e16c6ae5dd2ecd71625bb3b972669d21c9c7259 (patch)
tree8b0c0d42eef7d673a4eca5ee51f182655dc692d1
parentnet-misc/wireguard: prepend build_params instead of clobbering (diff)
downloadgentoo-2e16c6ae5dd2ecd71625bb3b972669d21c9c7259.tar.gz
gentoo-2e16c6ae5dd2ecd71625bb3b972669d21c9c7259.tar.bz2
gentoo-2e16c6ae5dd2ecd71625bb3b972669d21c9c7259.zip
vcs-snapshot.eclass: Doc that github 'archive' URLs don't need the eclass
-rw-r--r--eclass/vcs-snapshot.eclass10
1 files changed, 7 insertions, 3 deletions
diff --git a/eclass/vcs-snapshot.eclass b/eclass/vcs-snapshot.eclass
index d12ff2577b7..05c2d586cb6 100644
--- a/eclass/vcs-snapshot.eclass
+++ b/eclass/vcs-snapshot.eclass
@@ -1,4 +1,4 @@
-# Copyright 1999-2013 Gentoo Foundation
+# Copyright 1999-2016 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Id$
@@ -11,7 +11,7 @@
# the tarballs in SRC_URI to locations matching their (local) names,
# discarding the original parent directory.
#
-# The typical use case are VCS snapshots, coming from github, bitbucket
+# The typical use case are VCS snapshots, coming from bitbucket
# and similar services. They have hash appended to the directory name
# which makes extracting them a painful experience. But if you just use
# a SRC_URI arrow to rename it (which you're likely have to do anyway),
@@ -22,6 +22,10 @@
# fall back to regular unpack. Support for additional formats may be
# added at some point so please keep your SRC_URIs clean.
#
+# Note: this eclass is no longer needed with the new-style 'archive'
+# GitHub URLs. They have sane directory names and stable contents,
+# so you should really prefer them.
+#
# @EXAMPLE:
#
# @CODE
@@ -29,7 +33,7 @@
# inherit vcs-snapshot
#
# SRC_URI="https://github.com/example/${PN}/tarball/v${PV} -> ${P}.tar.gz
-# https://github.com/example/${PN}-otherstuff/tarball/v${PV} -> ${P}-otherstuff.tar.gz""
+# https://github.com/example/${PN}-otherstuff/tarball/v${PV} -> ${P}-otherstuff.tar.gz"
# @CODE
#
# and however the tarballs were originally packed, all files will appear