docs/manual: remove example comment causing issues
PATCH 1/1 docs/manual: remove example comment causing issues
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.
--- docs/manual/adding-packages-tips.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
docs/manual/adding-packages-tips.txt +1 -1
@@ -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)) ------------------------
Signature · 1 line
2.0.0
PATCH 1/1 docs/manual: remove example comment causing issues
Thomas, All,
On 2014-10-12 15:21 +0200, Thomas Petazzoni spake thusly:
Quoted 10 lines
The manual gives this example for using the github macro:
FOO_VERSION= v1.0 # tag or full commit IDUnfortunately, people copy/pasting this example will face weird make errors, because it leads the
FOO_VERSIONvariable to end with a space. Since the manual is anyway explaining just below the example thatFOO_VERSIONcan be used either with a tag or a full commit ID, the simplest solution is to simply remove this comment.
Quoted 3 lines
Reported-by Edd Robbins <[email protected]>Cc Edd Robbins <[email protected]>Signed-off-by Thomas Petazzoni <[email protected]>
Regards,
Yann E. MORIN.
Quoted 24 lines
--- docs/manual/adding-packages-tips.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)docs/manual/adding-packages-tips.txt +1
-1@@ -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)) ------------------------Signature · 6 lines
2.0.0 _______________________________________________ buildroot mailing list buildroot at busybox.net http://lists.busybox.net/mailman/listinfo/buildroot
Signature · 6 lines
.-----------------.--------------------.------------------.--------------------. | 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. | '------------------------------^-------^------------------^--------------------'
PATCH 1/1 docs/manual: remove example comment causing issues
In reply to Thomas PetazzoniQuoted 11 lines
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
"Thomas" == Thomas Petazzoni <[email protected]> writes:
The manual gives this example for using the github macro:
FOO_VERSION= v1.0 # tag or full commit IDUnfortunately, people copy/pasting this example will face weird make errors, because it leads the
FOO_VERSIONvariable to end with a space. Since the manual is anyway explaining just below the example thatFOO_VERSIONcan be used either with a tag or a full commit ID, the simplest solution is to simply remove this comment.
Quoted 3 lines
Reported-by Edd Robbins <[email protected]>Cc Edd Robbins <[email protected]>Signed-off-by Thomas Petazzoni <[email protected]>
Thanks, but I'll rather just fix the issue instead as people can very easily end up with something like this when E.G. testing a version bump.
Signature · 1 line
Bye, Peter Korsgaard