Patchwork [v2,2/2] Add FAQ entry how to properly add package from github.

login
register
mail settings
Submitter Marek Belisko
Date Sept. 15, 2012, 9:57 p.m.
Message ID <1347746247-12033-2-git-send-email-marek.belisko@open-nandra.com>
Download mbox | patch
Permalink /patch/184106/
State Superseded
Headers show

Comments

Marek Belisko - Sept. 15, 2012, 9:57 p.m.
Signed-off-by: Marek Belisko <marek.belisko@open-nandra.com>
---
 docs/manual/faq.txt |   20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
Samuel Martin - Sept. 16, 2012, 11:05 a.m.
Hi Marek,

2012/9/15 Marek Belisko <marek.belisko@open-nandra.com>:
> Signed-off-by: Marek Belisko <marek.belisko@open-nandra.com>
> ---
>  docs/manual/faq.txt |   20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
>
> diff --git a/docs/manual/faq.txt b/docs/manual/faq.txt
> index 575d019..abb499f 100644
> --- a/docs/manual/faq.txt
> +++ b/docs/manual/faq.txt
> @@ -36,3 +36,23 @@ then probably you are running a Fedora (or similar) distribution, and
>  you should install the +glibc-static+ package. This is because the
>  +module-init-tools+ build process wants to link statically against the
>  C library.
> +
> +How to add package from github
> +------------------------------
> +
> +If package don't have version number and want to use SHA1
> +(it's enough to use first 7 characters from SHA1):
> +
> +------------------------
> +FOO_VERSION = 1234567
> +FOO_SOURCE = user-package-$(FOO_VERSION).tar.gz
To be consistent with the rest of the doc, I'd prefer:
FOO_SOURCE = <user>-<package>-$(FOO_VERSION).tar.gz

> +FOO_SITE = http://github.com/user/package/tarball/master
I think this should be:
FOO_SITE = http://github.com/<user>/<package>/tarball/<branch>

Though most of the time, 'master' will be the branch name, some people
could have a branch per release or keep a 'stable' branch, so we
should not restrict this to 'master'


> +------------------------
> +
> +If package have version number use:
> +
> +------------------------
> +FOO_VERSION = v1.0
> +FOO_SOURCE = user-package-$(FOO_VERSION).tar.gz
> +FOO_SITE = http://github.com/user/package/tarball/$(FOO_VERSION)
> +------------------------

Ditto (about the user and package fields).


Cheers,

Patch

diff --git a/docs/manual/faq.txt b/docs/manual/faq.txt
index 575d019..abb499f 100644
--- a/docs/manual/faq.txt
+++ b/docs/manual/faq.txt
@@ -36,3 +36,23 @@  then probably you are running a Fedora (or similar) distribution, and
 you should install the +glibc-static+ package. This is because the
 +module-init-tools+ build process wants to link statically against the
 C library.
+
+How to add package from github
+------------------------------
+
+If package don't have version number and want to use SHA1
+(it's enough to use first 7 characters from SHA1):
+
+------------------------
+FOO_VERSION = 1234567
+FOO_SOURCE = user-package-$(FOO_VERSION).tar.gz
+FOO_SITE = http://github.com/user/package/tarball/master
+------------------------
+
+If package have version number use:
+
+------------------------
+FOO_VERSION = v1.0
+FOO_SOURCE = user-package-$(FOO_VERSION).tar.gz
+FOO_SITE = http://github.com/user/package/tarball/$(FOO_VERSION)
+------------------------