All of lore.kernel.org
 help / color / mirror / Atom feed
From: Yann E. MORIN <yann.morin.1998@free.fr>
To: buildroot@busybox.net
Subject: [Buildroot] [PATCH] docs/manual: remove example comment causing issues
Date: Sun, 12 Oct 2014 15:44:00 +0200	[thread overview]
Message-ID: <20141012134400.GA3674@free.fr> (raw)
In-Reply-To: <1413120085-21063-1-git-send-email-thomas.petazzoni@free-electrons.com>

Thomas, All,

On 2014-10-12 15:21 +0200, Thomas Petazzoni spake thusly:
> The manual gives this example for using the github macro:
> 
>   FOO_VERSION = v1.0 # tag or full commit ID
> 
> Unfortunately, people copy/pasting this example will face weird make
> errors, because it leads the FOO_VERSION variable to end with a
> space. Since the manual is anyway explaining just below the example
> that FOO_VERSION can be used either with a tag or a full commit ID,
> the simplest solution is to simply remove this comment.
> 
> Reported-by: Edd Robbins <edd.robbins@gmail.com>
> Cc: Edd Robbins <edd.robbins@gmail.com>
> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>

Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr>

Regards,
Yann E. MORIN.

> ---
>  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 0d4fcb0..fde0a44 100644
> --- a/docs/manual/adding-packages-tips.txt
> +++ b/docs/manual/adding-packages-tips.txt
> @@ -42,7 +42,7 @@ on GitHub. As GitHub is known to have changed download mechanisms in the
>  past, the 'github' helper function should be used as shown below.
>  
>  ------------------------
> -FOO_VERSION = v1.0 # tag or full commit ID
> +FOO_VERSION = v1.0
>  FOO_SITE = $(call github,<user>,<package>,$(FOO_VERSION))
>  ------------------------
>  
> -- 
> 2.0.0
> 
> _______________________________________________
> buildroot mailing list
> buildroot at busybox.net
> http://lists.busybox.net/mailman/listinfo/buildroot

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 223 225 172 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'

  reply	other threads:[~2014-10-12 13:44 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-10-12 13:21 [Buildroot] [PATCH] docs/manual: remove example comment causing issues Thomas Petazzoni
2014-10-12 13:44 ` Yann E. MORIN [this message]
2014-10-12 14:18 ` Peter Korsgaard

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20141012134400.GA3674@free.fr \
    --to=yann.morin.1998@free.fr \
    --cc=buildroot@busybox.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.