diff mbox

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

Message ID 1347912277-3982-1-git-send-email-marek.belisko@open-nandra.com
State Superseded
Headers show

Commit Message

Marek Belisko Sept. 17, 2012, 8:04 p.m. UTC
Signed-off-by: Marek Belisko <marek.belisko@open-nandra.com>
---
 docs/manual/faq.txt |   20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

Comments

Samuel Martin Sept. 17, 2012, 8:28 p.m. UTC | #1
Hi Marek,

2012/9/17 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..f04a93e 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):

IANA native English speaker, but I'd have rephrased this with
something like that:

If the package has no release version, or its version cannot be
identified using tag, then the sha1 of the particular commit should be
used to identify the version (the first 7 characters of the sha1 are
enough):

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

Same here:

If the package version matches a tag, then this tag should be used to
identify the version:

> +
> +------------------------
> +FOO_VERSION = v1.0
> +FOO_SOURCE = <user>-<package>-$(FOO_VERSION).tar.gz
> +FOO_SITE = http://github.com/<user>/<package>/tarball/$(FOO_VERSION)
> +------------------------


Regards,
Belisko Marek Sept. 17, 2012, 8:41 p.m. UTC | #2
Hi Samuel,

On Mon, Sep 17, 2012 at 10:28 PM, Samuel Martin <s.martin49@gmail.com> wrote:
> Hi Marek,
>
> 2012/9/17 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..f04a93e 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):
>
> IANA native English speaker, but I'd have rephrased this with
> something like that:
Same here ;) . Your sentence is much better then mine. Will send updated patch.
Thanks.
>
> If the package has no release version, or its version cannot be
> identified using tag, then the sha1 of the particular commit should be
> used to identify the version (the first 7 characters of the sha1 are
> enough):
>
>> +
>> +------------------------
>> +FOO_VERSION = 1234567
>> +FOO_SOURCE = <user>-<package>-$(FOO_VERSION).tar.gz
>> +FOO_SITE = http://github.com/<user>/<package>/tarball/<branch>
>> +------------------------
>> +
>> +If package have version number use:
>
> Same here:
>
> If the package version matches a tag, then this tag should be used to
> identify the version:
>
>> +
>> +------------------------
>> +FOO_VERSION = v1.0
>> +FOO_SOURCE = <user>-<package>-$(FOO_VERSION).tar.gz
>> +FOO_SITE = http://github.com/<user>/<package>/tarball/$(FOO_VERSION)
>> +------------------------
>
>
> Regards,
>
> --
> Sam

Cheers,

mbe
diff mbox

Patch

diff --git a/docs/manual/faq.txt b/docs/manual/faq.txt
index 575d019..f04a93e 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/<branch>
+------------------------
+
+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)
+------------------------