diff mbox

manual: Add note about uses of github helper

Message ID 1413189118-12645-1-git-send-email-maxime.hadjinlian@gmail.com
State Superseded
Headers show

Commit Message

Maxime Hadjinlian Oct. 13, 2014, 8:31 a.m. UTC
Add a little comment regarding the uses of the github helper for the releases.

Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com>
Cc: Samuel Martin <s.martin49@gmail.com>
---
 docs/manual/adding-packages-tips.txt | 11 +++++++++++
 1 file changed, 11 insertions(+)

Comments

Samuel Martin Oct. 13, 2014, 9:05 a.m. UTC | #1
Hi Maxime,

On Mon, Oct 13, 2014 at 10:31 AM, Maxime Hadjinlian
<maxime.hadjinlian@gmail.com> wrote:
> Add a little comment regarding the uses of the github helper for the releases.
>
> Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com>
> Cc: Samuel Martin <s.martin49@gmail.com>
> ---
>  docs/manual/adding-packages-tips.txt | 11 +++++++++++
>  1 file changed, 11 insertions(+)
>
> diff --git a/docs/manual/adding-packages-tips.txt b/docs/manual/adding-packages-tips.txt
> index 0d4fcb0..30f8184 100644
> --- a/docs/manual/adding-packages-tips.txt
> +++ b/docs/manual/adding-packages-tips.txt
> @@ -52,3 +52,14 @@ 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 you should specify +FOO_SITE+ like any generic packages.

Green button is the tarball uploaded by the maintainer, I think this
tarball should be taken in priority over the one generated by github
(grey button).

> +- 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.
> --
> 2.1.1
>


Regards,
Lionel Orry Oct. 13, 2014, 6:38 p.m. UTC | #2
Hi Maxime,

On Mon, Oct 13, 2014 at 10:31 AM, Maxime Hadjinlian
<maxime.hadjinlian@gmail.com> wrote:
> Add a little comment regarding the uses of the github helper for the releases.
>
> Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com>
> Cc: Samuel Martin <s.martin49@gmail.com>
> ---
>  docs/manual/adding-packages-tips.txt | 11 +++++++++++
>  1 file changed, 11 insertions(+)
>
> diff --git a/docs/manual/adding-packages-tips.txt b/docs/manual/adding-packages-tips.txt
> index 0d4fcb0..30f8184 100644
> --- a/docs/manual/adding-packages-tips.txt
> +++ b/docs/manual/adding-packages-tips.txt
> @@ -52,3 +52,14 @@ 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 you should specify +FOO_SITE+ like any generic packages.

s/you should you should/you should/
Maybe also state that the green button actually links to the correct
URL we want to extract FOO_SITE from...

> +- 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.
> --
> 2.1.1
>
> _______________________________________________
> buildroot mailing list
> buildroot@busybox.net
> http://lists.busybox.net/mailman/listinfo/buildroot

Regards,
Lionel
diff mbox

Patch

diff --git a/docs/manual/adding-packages-tips.txt b/docs/manual/adding-packages-tips.txt
index 0d4fcb0..30f8184 100644
--- a/docs/manual/adding-packages-tips.txt
+++ b/docs/manual/adding-packages-tips.txt
@@ -52,3 +52,14 @@  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 you should specify +FOO_SITE+ like any generic packages.
+- 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.