vcs-snapshot.eclass: Doc that github 'archive' URLs don't need the eclass
authorMichał Górny <mgorny@gentoo.org>
Tue, 26 Jul 2016 15:41:27 +0000 (17:41 +0200)
committerMichał Górny <mgorny@gentoo.org>
Tue, 26 Jul 2016 15:43:53 +0000 (17:43 +0200)
eclass/vcs-snapshot.eclass

index d12ff2577b720699a45adbf589d1d9fd2728354d..05c2d586cb6fa50d7e8ffc6a9e3ad8ed25d5ea37 100644 (file)
@@ -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),
 # 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