[Buildroot] [PATCH] manual: Add note about uses of github helper

[Buildroot] [PATCH] manual: Add note about uses of github helper

[Maxime Hadjinlian]

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.
+- 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] [PATCH] manual: Add note about uses of github helper

[Samuel Martin]

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,

-- 
Samuel

[Buildroot] [PATCH] manual: Add note about uses of github helper

[Lionel Orry]

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 at busybox.net
> http://lists.busybox.net/mailman/listinfo/buildroot

Regards,
Lionel

[Buildroot] [PATCH] manual: Add note about uses of github helper

[Arnout Vandecappelle]

From: Maxime Hadjinlian <maxime.hadjinlian@gmail.com>

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 <maxime.hadjinlian@gmail.com>
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Cc: Samuel Martin <s.martin49@gmail.com>
---
 docs/manual/adding-packages-tips.txt | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/docs/manual/adding-packages-tips.txt b/docs/manual/adding-packages-tips.txt
index 0d4fcb0..0c6018a 100644
--- a/docs/manual/adding-packages-tips.txt
+++ b/docs/manual/adding-packages-tips.txt
@@ -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

[Buildroot] [PATCH] manual: Add note about uses of github helper

[Samuel Martin]

On Wed, Oct 15, 2014 at 2:24 PM, Arnout Vandecappelle (Essensium/Mind)
<arnout@mind.be> wrote:
> From: Maxime Hadjinlian <maxime.hadjinlian@gmail.com>
>
> 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 <maxime.hadjinlian@gmail.com>
> Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
> Cc: Samuel Martin <s.martin49@gmail.com>

Acked-by: Samuel Martin <s.martin49@gmail.com>

> ---
>  docs/manual/adding-packages-tips.txt | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
>
> diff --git a/docs/manual/adding-packages-tips.txt b/docs/manual/adding-packages-tips.txt
> index 0d4fcb0..0c6018a 100644
> --- a/docs/manual/adding-packages-tips.txt
> +++ b/docs/manual/adding-packages-tips.txt
> @@ -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
>



-- 
Samuel

[Buildroot] [PATCH] manual: Add note about uses of github helper

[Maxime Hadjinlian]

Thanks Arnout, it is indeed much better.

On Oct 15, 2014 2:30 PM, "Samuel Martin" <s.martin49@gmail.com> wrote:
>
> On Wed, Oct 15, 2014 at 2:24 PM, Arnout Vandecappelle (Essensium/Mind)
> <arnout@mind.be> wrote:
> > From: Maxime Hadjinlian <maxime.hadjinlian@gmail.com>
> >
> > 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 <maxime.hadjinlian@gmail.com>
> > Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
> > Cc: Samuel Martin <s.martin49@gmail.com>
>
> Acked-by: Samuel Martin <s.martin49@gmail.com>
>
> > ---
> >  docs/manual/adding-packages-tips.txt | 17 +++++++++++++++++
> >  1 file changed, 17 insertions(+)
> >
> > diff --git a/docs/manual/adding-packages-tips.txt
b/docs/manual/adding-packages-tips.txt
> > index 0d4fcb0..0c6018a 100644
> > --- a/docs/manual/adding-packages-tips.txt
> > +++ b/docs/manual/adding-packages-tips.txt
> > @@ -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
> >
>
>
>
> --
> Samuel
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.busybox.net/pipermail/buildroot/attachments/20141015/c91d8928/attachment.html>

[Buildroot] [PATCH] manual: Add note about uses of github helper

[Thomas Petazzoni]

Dear Arnout Vandecappelle (Essensium/Mind),

On Wed, 15 Oct 2014 14:24:20 +0200, Arnout Vandecappelle
(Essensium/Mind) wrote:
> From: Maxime Hadjinlian <maxime.hadjinlian@gmail.com>
> 
> 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 <maxime.hadjinlian@gmail.com>
> Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
> Cc: Samuel Martin <s.martin49@gmail.com>
> ---
>  docs/manual/adding-packages-tips.txt | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)

Applied, thanks.

Thomas
-- 
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com