manual: Add note about uses of github helper
PATCH 1/1 manual: Add note about uses of github helper
From: Maxime Hadjinlian <[email protected]>
Add a little comment regarding the uses of the github helper for the releases.
[Arnout: extend the comment a little]
--- docs/manual/adding-packages-tips.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)
docs/manual/adding-packages-tips.txt +17 -0
@@ -52,3 +52,20 @@ FOO_SITE = $(call github,<user>,<package>,$(FOO_VERSION)) Buildroot (e.g.: +foo-f6fb6654af62045239caed5950bc6c7971965e60.tar.gz+), so it is not necessary to specify it in the +.mk+ file. - When using a commit ID as version, you should use the full 40 hex characters. + +If the package you wish to add does have a release section on GitHub, the +maintainer may have uploaded a release tarball, or the release may just point +to the automatically generated tarball from the git tag. If there is a +release tarball uploaded by the maintainer, we prefer to use that since it +may be slightly different (e.g. it contains a configure script so we don't +need to do AUTORECONF). + +You can see on the release page if it's an uploaded tarball or a git tag: +- If there is a green download button, like + https://github.com/zedshaw/mongrel2/releases/tag/v1.9.1[mongrel2], then it + was uploaded by the maintainer and you should use the link of that button to + specify +FOO_SITE+. +- If there is grey download button, like + https://github.com/xbmc/xbmc/releases/tag/13.2-Gotham[xbmc], then it's an + automatically generated tarball and you should use the 'github' helper + function.
Signature · 1 line
2.1.1
PATCH 1/1 manual: Add note about uses of github helper
Quoted 9 lines · Arnout Vandecappelle (Essensium/Mind)
From: Maxime Hadjinlian <[email protected]>
Add a little comment regarding the uses of the github helper for the releases.
[Arnout: extend the comment a little]
Signed-off-by Maxime Hadjinlian <[email protected]>Cc Samuel Martin <[email protected]>
Quoted 32 lines
--- docs/manual/adding-packages-tips.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)docs/manual/adding-packages-tips.txt +17
-1@@ -52,3 +52,20 @@ FOO_SITE = $(call github,<user>,<package>,$(FOO_VERSION)) Buildroot (e.g.: +foo-f6fb6654af62045239caed5950bc6c7971965e60.tar.gz+), so it is not necessary to specify it in the +.mk+ file. - When using a commit ID as version, you should use the full 40 hex characters. + +If the package you wish to add does have a release section on GitHub, the +maintainer may have uploaded a release tarball, or the release may just point +to the automatically generated tarball from the git tag. If there is a +release tarball uploaded by the maintainer, we prefer to use that since it +may be slightly different (e.g. it contains a configure script so we don't +need to do AUTORECONF). + +You can see on the release page if it's an uploaded tarball or a git tag: +- If there is a green download button, like + https://github.com/zedshaw/mongrel2/releases/tag/v1.9.1[mongrel2], then it + was uploaded by the maintainer and you should use the link of that button to + specify +FOO_SITE+. +- If there is grey download button, like + https://github.com/xbmc/xbmc/releases/tag/13.2-Gotham[xbmc], then it's an + automatically generated tarball and you should use the 'github' helper + function. --2.1.1
Signature · 1 line
Samuel
PATCH 1/1 manual: Add note about uses of github helper
Thanks Arnout, it is indeed much better.
Quoted 6 lines · Samuel Martin
Quoted 3 lines · Arnout Vandecappelle (Essensium/Mind)
From: Maxime Hadjinlian <[email protected]>
Add a little comment regarding the uses of the github helper for the
releases.
Quoted 7 lines
Quoted 6 lines
[Arnout: extend the comment a little]
Signed-off-by Maxime Hadjinlian <[email protected]>Cc Samuel Martin <[email protected]>
Quoted 7 lines
Acked-by Samuel Martin <[email protected]>Review
Quoted 5 lines
--- docs/manual/adding-packages-tips.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)(quoted diff) +0
-0
b/docs/manual/adding-packages-tips.txt
Quoted 4 lines
docs/manual/adding-packages-tips.txt FOO_SITE = $(call
Quoted 4 lines
index 0d4fcb0..0c6018a 100644
docs/manual/adding-packages-tips.txt +0
-0@@ -52,3 +52,20 @@ FOO_SITE = $(call
github,<user>,<package>,$(FOO_VERSION))
Quoted 1 line
docs/manual/adding-packages-tips.txt FOO_SITE = $(call · line 52
Quoted 1 line
docs/manual/adding-packages-tips.txt +0
-0Buildroot (e.g.:
+foo-f6fb6654af62045239caed5950bc6c7971965e60.tar.gz+),
Quoted 2 lines
docs/manual/adding-packages-tips.txt FOO_SITE = $(call · line 54
Quoted 2 lines
docs/manual/adding-packages-tips.txt +0
-0so it is not necessary to specify it in the +.mk+ file. - When using a commit ID as version, you should use the full 40 hex
characters.
Quoted 2 lines
docs/manual/adding-packages-tips.txt FOO_SITE = $(call · line 56
Quoted 2 lines
docs/manual/adding-packages-tips.txt +2
-0+ +If the package you wish to add does have a release section on GitHub,
the
Quoted 1 line
docs/manual/adding-packages-tips.txt FOO_SITE = $(call · line 57
Quoted 1 line
docs/manual/adding-packages-tips.txt +1
-0+maintainer may have uploaded a release tarball, or the release may
just point
Quoted 2 lines
docs/manual/adding-packages-tips.txt FOO_SITE = $(call · line 59
Quoted 2 lines
docs/manual/adding-packages-tips.txt +2
-0+to the automatically generated tarball from the git tag. If there is a +release tarball uploaded by the maintainer, we prefer to use that
since it
Quoted 1 line
docs/manual/adding-packages-tips.txt FOO_SITE = $(call · line 60
Quoted 1 line
docs/manual/adding-packages-tips.txt +1
-0+may be slightly different (e.g. it contains a configure script so we
don't
Quoted 3 lines
docs/manual/adding-packages-tips.txt FOO_SITE = $(call github,<user>,<package>,$(FOO_VERSION))
Quoted 3 lines
docs/manual/adding-packages-tips.txt +3
-0+need to do AUTORECONF). + +You can see on the release page if it's an uploaded tarball or a git
tag:
Quoted 2 lines
docs/manual/adding-packages-tips.txt FOO_SITE = $(call · line 65
Quoted 2 lines
docs/manual/adding-packages-tips.txt +2
-0+- If there is a green download button, like + https://github.com/zedshaw/mongrel2/releases/tag/v1.9.1[mongrel2],
then it
Quoted 1 line
docs/manual/adding-packages-tips.txt FOO_SITE = $(call · line 66
Quoted 1 line
docs/manual/adding-packages-tips.txt +1
-0+ was uploaded by the maintainer and you should use the link of that
button to
Quoted 3 lines
docs/manual/adding-packages-tips.txt FOO_SITE = $(call github,<user>,<package>,$(FOO_VERSION))
Quoted 3 lines
docs/manual/adding-packages-tips.txt +3
-0+ specify +FOO_SITE+. +- If there is grey download button, like + https://github.com/xbmc/xbmc/releases/tag/13.2-Gotham[xbmc], then
it's an
Quoted 1 line
docs/manual/adding-packages-tips.txt FOO_SITE = $(call · line 70
Quoted 1 line
docs/manual/adding-packages-tips.txt +1
-0+ automatically generated tarball and you should use the 'github'
helper
Quoted 9 lines
Quoted 4 lines
docs/manual/adding-packages-tips.txt +1
-1+ function. --2.1.1
--
Samuel
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.busybox.net/pipermail/buildroot/attachments/20141015/c91d8928/attachment.html>
Thomas Petazzoni
AppliedPATCH 1/1 manual: Add note about uses of github helper
In reply to Arnout Vandecappelle (Essensium/Mind)Dear Arnout Vandecappelle (Essensium/Mind),
Quoted 4 lines · Arnout Vandecappelle (Essensium/Mind)
From: Maxime Hadjinlian <[email protected]>
Add a little comment regarding the uses of the github helper for the releases.
Quoted 8 lines
[Arnout: extend the comment a little]
Signed-off-by Maxime Hadjinlian <[email protected]>Cc Samuel Martin <[email protected]>--- docs/manual/adding-packages-tips.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)
Applied, thanks.
Thomas
Signature · 3 lines
Thomas Petazzoni, CTO, Free Electrons Embedded Linux, Kernel and Android engineering http://free-electrons.com