[Buildroot] [PATCH] docs/manual: remove example comment causing issues

Thomas Petazzoni thomas.petazzoni at free-electrons.com
Sun Oct 12 13:21:25 UTC 2014


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 at gmail.com>
Cc: Edd Robbins <edd.robbins at gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni at free-electrons.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 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



More information about the buildroot mailing list