[Buildroot] [PATCH 1/1] docs/manual: update information about how to add a package from github

[Samuel Martin]

Jerzy,

2013/9/30 Jerzy Grzegorek <jerzy.grzegorek at trzebnica.net>

> Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek at trzebnica.net>
> ---
>  docs/manual/adding-packages-tips.txt |   62
> +++++++++++++++++++++++++++++++---
>  1 file changed, 57 insertions(+), 5 deletions(-)
>
> diff --git a/docs/manual/adding-packages-tips.txt
> b/docs/manual/adding-packages-tips.txt
> index 8b27c61..67a8610 100644
> --- a/docs/manual/adding-packages-tips.txt
> +++ b/docs/manual/adding-packages-tips.txt
> @@ -41,17 +41,69 @@ How to add a package from github
>
>  Packages on github often don't have a download area with release tarballs.
>  However, it is possible to download tarballs directly from the repository
> -on github.
> +on github. There are two possibilities:
> +
> +1. Using (abbreviated) commit ID
> +
> +------------------------
> +FOO_VERSION = 1234567
> +FOO_SITE = https://github.com/<user>/<package>/tarball/$(FOO_VERSION)
> +------------------------
> +
> +tarball name downloaded by Buildroot: foo-1234567.tar.gz
> +
> +example:
> +package: cpuload
> +abbreviated commit ID: 96ac037
> +CPULOAD_VERSION = 96ac037
> +CPULOAD_SITE =
> https://github.com/kelvincheung/cpuload/tarball/$(CPULOAD_VERSION)
> +tarball name downloaded by Buildroot: cpuload-96ac037.tar.gz
> +
> +
> +2. Using tag
> +
> +a) tag without prefix
> +
> +------------------------
> +FOO_VERSION = 1.0
> +FOO_SITE = https://github.com/<user>/<package>/tarball/$(FOO_VERSION)
> +------------------------
> +
> +tarball name downloaded by Buildroot: foo-1.0.tar.gz
> +
> +example:
> +package: luacrypto
> +tag: 0.3.2
> +LUACRYPTO_VERSION = 0.3.2
> +LUACRYPTO_SITE =
> https://github.com/mkottman/luacrypto/tarball/$(LUACRYPTO_VERSION)
> +tarball name downloaded by Buildroot: luacrypto-0.3.2.tar.gz
> +
> +b) tag with prefix
>
>  ------------------------
> -FOO_VERSION = v1.0 # tag or (abbreviated) commit ID
> -FOO_SITE = http://github.com/<user>/<package>/tarball/$(FOO_VERSION)
> +FOO_VERSION = 1.0
> +FOO_SITE = https://github.com/
> <user>/<package>/tarball/<prefix>$(FOO_VERSION)
>  ------------------------
>
> +tarball name downloaded by Buildroot: foo-1.0.tar.gz
> +
> +examples:
> +package: cpuload
> +tag: v0.3
> +CPULOAD_VERSION = 0.3
> +CPULOAD_SITE =
> https://github.com/kelvincheung/cpuload/tarball/v$(CPULOAD_VERSION)
> +tarball name downloaded by Buildroot: cpuload-0.3.tar.gz
> +
> +package: libcec
> +tag: libcec-2.1.1
> +LIBCEC_VERSION = 2.1.1
> +LIBCEC_SITE =
> https://github.com/Pulse-Eight/libcec/tarball/libcec-$(LIBCEC_VERSION)
> +tarball name downloaded by Buildroot: libcec-2.1.1.tar.gz
> +
>  .Notes
> -- The FOO_VERSION can either be a tag or a commit ID.
>  - The tarball name generated by github matches the default one from
> -  Buildroot (e.g.: +foo-1234567.tar.gz+),
> +  Buildroot (e.g.: +foo-1234567.tar.gz+ or +foo-1.0.tar.gz+)
>    so it is not necessary to specify it in the +.mk+ file.
>  - When using a commit ID as version, usually the first 7 characters of
>    the SHA1 are enough.
> +- https vs http avoids redirection
>


Since the following patch http://patchwork.ozlabs.org/patch/278164/ has
been rejected,
there is no reason to update the manual.

Regards,

-- 
Samuel
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.buildroot.org/pipermail/buildroot/attachments/20131027/adba3bc7/attachment.html>