Skip to contentSkip to conversation

manual: Add note about uses of github helper

PATCH New Maxime Hadjinlian 2 participants 2 messages Oct 14, 2014 – Oct 15, 2014

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 manual: Add note about uses of github helper

Add a little comment regarding the uses of the github helper for the releases.

---
v1 -> v2:
- Remove typo
- Add indication to uses green button's link

---
 docs/manual/adding-packages-tips.txt | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
docs/manual/adding-packages-tips.txt +14 -0
index 0d4fcb0..9896a9b 100644
@@ -52,3 +52,17 @@ 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,
+you need to be careful, the maintainer of the package may have
+uploaded a specific file along with the releases.
+You can see it from the pages:
+- If there is a green download button, like
+  https://github.com/zedshaw/mongrel2/releases/tag/v1.9.1[mongrel2], you
+  should uses the link of that button to specify +FOO_SITE+.
+- If there is grey downlaod button, like
+  https://github.com/xbmc/xbmc/releases/tag/13.2-Gotham[xbmc], then you
+  can use the 'github' helper.
+
+If there is a green download button, it should be used in priority over
+the grey one.
Signature · 1 line
2.1.1
#1 lore raw

PATCH v3 1/1 manual: Add note about uses of github helper

Quoted 17 lines · Maxime Hadjinlian

Add a little comment regarding the uses of the github helper for the releases.

---
v1 -> v2:
- Remove typo
- Add indication to uses green button's link

---
 docs/manual/adding-packages-tips.txt | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
docs/manual/adding-packages-tips.txt +0 -0
index 0d4fcb0..9896a9b 100644

docs/manual/adding-packages-tips.txt FOO_SITE = $(call github,<user>,<package>,$(FOO_VERSION)) · line 58

Quoted 7 lines
docs/manual/adding-packages-tips.txt +4 -0
@@ -52,3 +52,17 @@ 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,
+you need to be careful, the maintainer of the package may have
+uploaded a specific file along with the releases.

Sorry, still not clear enough for me :-). I'm going to repost, that's easier
than commenting here.

Regards,
Arnout

Quoted 11 lines
docs/manual/adding-packages-tips.txt +10 -0
+You can see it from the pages:
+- If there is a green download button, like
+  https://github.com/zedshaw/mongrel2/releases/tag/v1.9.1[mongrel2], you
+  should uses the link of that button to specify +FOO_SITE+.
+- If there is grey downlaod button, like
+  https://github.com/xbmc/xbmc/releases/tag/13.2-Gotham[xbmc], then you
+  can use the 'github' helper.
+
+If there is a green download button, it should be used in priority over
+the grey one.
Signature · 6 lines
Arnout Vandecappelle                          arnout at mind be
Senior Embedded Software Architect            +32-16-286500
Essensium/Mind                                http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium           BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7CB5 E4CC 6C2E EFD4 6E3D A754 F963 ECAB 2450 2F1F