[Buildroot] [PATCH] docs/manual: fix bash export syntax in example code

[Buildroot] [PATCH] docs/manual: fix bash export syntax in example code

[Luca Ceresoli]

To export a variable in .bashrc we shouldn't put a '$' at the
beginning of the line, and there must be a '=' between key and value.

Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
---
 docs/manual/download-location.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/manual/download-location.txt b/docs/manual/download-location.txt
index cca7e7e..0b53f54 100644
--- a/docs/manual/download-location.txt
+++ b/docs/manual/download-location.txt
@@ -17,7 +17,7 @@ set, then the value of +BR2_DL_DIR+ in the Buildroot configuration is
 overridden. The following line should be added to +<~/.bashrc>+.
 
 -----------------
- $ export BR2_DL_DIR <shared download location>
+ export BR2_DL_DIR=<shared download location>
 -----------------
 
 The download location can also be set in the +.config+ file, with the
-- 
1.9.1

[Buildroot] [PATCH] docs/manual: fix bash export syntax in example code

[Thomas Petazzoni]

Dear Luca Ceresoli,

On Wed, 11 Nov 2015 18:47:41 +0100, Luca Ceresoli wrote:
> To export a variable in .bashrc we shouldn't put a '$' at the
> beginning of the line, and there must be a '=' between key and value.

Well the $ is here to indicate that it's the shell prompt.

Thomas
-- 
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com

[Buildroot] [PATCH] docs/manual: fix bash export syntax in example code

[Luca Ceresoli]

Dear Thomas,

Thomas Petazzoni wrote:
> Dear Luca Ceresoli,
>
> On Wed, 11 Nov 2015 18:47:41 +0100, Luca Ceresoli wrote:
>> To export a variable in .bashrc we shouldn't put a '$' at the
>> beginning of the line, and there must be a '=' between key and value.
>
> Well the $ is here to indicate that it's the shell prompt.

I would agree if this specific part of the manual were suggesting a
shell command in general. Instead it's suggesting to add a line to
~/.bashrc, where a '$' does not make sense of course.

Maybe I should have explained it in my commit message?

-- 
Luca

[Buildroot] [PATCH] docs/manual: fix bash export syntax in example code

[Thomas Petazzoni]

Luca,

On Wed, 11 Nov 2015 21:50:49 +0100, Luca Ceresoli wrote:

> I would agree if this specific part of the manual were suggesting a
> shell command in general. Instead it's suggesting to add a line to
> ~/.bashrc, where a '$' does not make sense of course.

Ah, indeed, I missed that. Thanks for the explanation.

Thomas
-- 
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com

[Buildroot] [PATCH] docs/manual: fix bash export syntax in example code

[Thomas Petazzoni]

Dear Luca Ceresoli,

On Wed, 11 Nov 2015 18:47:41 +0100, Luca Ceresoli wrote:
> To export a variable in .bashrc we shouldn't put a '$' at the
> beginning of the line, and there must be a '=' between key and value.
> 
> Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
> ---
>  docs/manual/download-location.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Applied, thanks.

Thomas
-- 
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com