Patchwork [1/1] manual: correct error in github tarball information

login
register
mail settings
Submitter Spenser Gilliland
Date June 7, 2013, 12:03 a.m.
Message ID <1370563406-3124-1-git-send-email-spenser@gillilanding.com>
Download mbox | patch
Permalink /patch/249557/
State Accepted
Commit 484b6dd8a3abccf0be34d1bed3761a8809ba23be
Headers show

Comments

Spenser Gilliland - June 7, 2013, 12:03 a.m.
Updates to manual for bug 6302

Signed-off-by: Spenser Gilliland <spenser@gillilanding.com>
---
 docs/manual/adding-packages-tips.txt |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Samuel Martin - June 7, 2013, 8:25 a.m.
Hi Spenser,

2013/6/7 Spenser Gilliland <spenser@gillilanding.com>:
> Updates to manual for bug 6302
>
> Signed-off-by: Spenser Gilliland <spenser@gillilanding.com>
> ---
>  docs/manual/adding-packages-tips.txt |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/docs/manual/adding-packages-tips.txt b/docs/manual/adding-packages-tips.txt
> index 21e520b..f435add 100644
> --- a/docs/manual/adding-packages-tips.txt
> +++ b/docs/manual/adding-packages-tips.txt
> @@ -58,7 +58,7 @@ enough):
>
>  ------------------------
>  FOO_VERSION = 1234567
> -FOO_SITE = http://github.com/<user>/<package>/tarball/<branch>
> +FOO_SITE = http://github.com/<user>/<package>/tarball/$(FOO_VERSION)
>  ------------------------

I'd have slightly reword the whole section, since there is no
difference between FOO_VERSION being a tag or a commit id,
something like this:

---
------------------------
FOO_VERSION = v1.0 # tag or commit ID
FOO_SITE = http://github.com/<user>/<package>/tarball/$(FOO_VERSION)
------------------------

.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+),
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.
---

Regards,
Peter Korsgaard - June 7, 2013, 8:50 a.m.
>>>>> "Spenser" == Spenser Gilliland <spenser@gillilanding.com> writes:

 Spenser> Updates to manual for bug 6302
 Spenser> Signed-off-by: Spenser Gilliland <spenser@gillilanding.com>

Committed, thanks.
Peter Korsgaard - June 7, 2013, 8:50 a.m.
>>>>> "Samuel" == Samuel Martin <s.martin49@gmail.com> writes:

 >> ------------------------
 >> FOO_VERSION = 1234567
 >> -FOO_SITE = http://github.com/<user>/<package>/tarball/<branch>
 >> +FOO_SITE = http://github.com/<user>/<package>/tarball/$(FOO_VERSION)
 >> ------------------------

 Samuel> I'd have slightly reword the whole section, since there is no
 Samuel> difference between FOO_VERSION being a tag or a commit id,
 Samuel> something like this:

 Samuel> ---
 Samuel> ------------------------
 Samuel> FOO_VERSION = v1.0 # tag or commit ID
 Samuel> FOO_SITE = http://github.com/<user>/<package>/tarball/$(FOO_VERSION)
 Samuel> ------------------------

 Samuel> .Notes
 Samuel> - The FOO_VERSION can either be a tag or a commit ID.
 Samuel> - The tarball name generated by github matches the default one from
 Samuel> Buildroot (e.g.: +foo-1234567.tar.gz+),
 Samuel> so it is not necessary to specify it in the +.mk+ file.
 Samuel> - When using a commit ID as version, usually the first 7 characters of
 Samuel> the SHA1 are enough.

Agreed. I've fixed this in git now, thanks.

Patch

diff --git a/docs/manual/adding-packages-tips.txt b/docs/manual/adding-packages-tips.txt
index 21e520b..f435add 100644
--- a/docs/manual/adding-packages-tips.txt
+++ b/docs/manual/adding-packages-tips.txt
@@ -58,7 +58,7 @@  enough):
 
 ------------------------
 FOO_VERSION = 1234567
-FOO_SITE = http://github.com/<user>/<package>/tarball/<branch>
+FOO_SITE = http://github.com/<user>/<package>/tarball/$(FOO_VERSION)
 ------------------------
 
 Note that the name of the tarball is the default +foo-1234567.tar.gz+