diff mbox

[1,of,2] manual: github commits should be specified in full

Message ID 8e7644076c9433349531.1383394317@argentina
State Superseded
Headers show

Commit Message

Thomas De Schampheleire Nov. 2, 2013, 12:11 p.m. UTC
Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>

---
 docs/manual/adding-packages-tips.txt |  5 ++---
 1 files changed, 2 insertions(+), 3 deletions(-)

Comments

Samuel Martin Nov. 2, 2013, 1:01 p.m. UTC | #1
Hi Thomas,


2013/11/2 Thomas De Schampheleire <patrickdepinguin@gmail.com>

> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
>
> ---
>  docs/manual/adding-packages-tips.txt |  5 ++---
>  1 files changed, 2 insertions(+), 3 deletions(-)
>
> diff --git a/docs/manual/adding-packages-tips.txt
> b/docs/manual/adding-packages-tips.txt
> --- a/docs/manual/adding-packages-tips.txt
> +++ b/docs/manual/adding-packages-tips.txt
> @@ -44,7 +44,7 @@ However, it is possible to download tarb
>  on github.
>
>  ------------------------
> -FOO_VERSION = v1.0 # tag or (abbreviated) commit ID
> +FOO_VERSION = v1.0 # tag or (full) commit ID
>
I think the brackets are not necessary around "full".

 FOO_SITE = http://github.com/<user>/<package>/tarball/$(FOO_VERSION)
>  ------------------------
>
> @@ -53,5 +53,4 @@ FOO_SITE = http://github.com/<user>/<pac
>  - The tarball name generated by github matches the default one from
>    Buildroot (e.g.: +foo-1234567.tar.gz+),
>
The example should use a full commit ID


>    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.
> +- When using a commit ID as version, you should use the full 40 hex
> characters.
>

Otherwise, it looks good to me.

Regards,
diff mbox

Patch

diff --git a/docs/manual/adding-packages-tips.txt b/docs/manual/adding-packages-tips.txt
--- a/docs/manual/adding-packages-tips.txt
+++ b/docs/manual/adding-packages-tips.txt
@@ -44,7 +44,7 @@  However, it is possible to download tarb
 on github.
 
 ------------------------
-FOO_VERSION = v1.0 # tag or (abbreviated) commit ID
+FOO_VERSION = v1.0 # tag or (full) commit ID
 FOO_SITE = http://github.com/<user>/<package>/tarball/$(FOO_VERSION)
 ------------------------
 
@@ -53,5 +53,4 @@  FOO_SITE = http://github.com/<user>/<pac
 - 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.
+- When using a commit ID as version, you should use the full 40 hex characters.