diff mbox

[8/9] manual: Harmonize command example

Message ID 1416068964-22529-8-git-send-email-maxime.hadjinlian@gmail.com
State Rejected
Headers show

Commit Message

Maxime Hadjinlian Nov. 15, 2014, 4:29 p.m. UTC
To facilitate copy/paste for manual's reader, remove anything before
command example.

Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com>
---
 docs/manual/customize-outside-br.txt | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

Comments

Yann E. MORIN Nov. 19, 2014, 10:32 p.m. UTC | #1
Maxime, All,

On 2014-11-15 17:29 +0100, Maxime Hadjinlian spake thusly:
> To facilitate copy/paste for manual's reader, remove anything before
> command example.
> 
> Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com>

Ditto: I'd have preferred we keep a leading $. Still, for the same
reasons as the previous patch:
-- Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>

But see below...

> ---
>  docs/manual/customize-outside-br.txt | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/docs/manual/customize-outside-br.txt b/docs/manual/customize-outside-br.txt
> index 5d63e60..2b01433 100644
> --- a/docs/manual/customize-outside-br.txt
> +++ b/docs/manual/customize-outside-br.txt
> @@ -30,30 +30,30 @@ but if it's passed as a relative path, it is important to note that it
>  is interpreted relative to the main Buildroot source directory, *not*
>  to the Buildroot output directory.
>  
> -Some examples:
> +Some examples, assuming you are inside the main Buildroot source directory:
>  
>  -----
> - buildroot/ $ make BR2_EXTERNAL=/path/to/foobar menuconfig
> +make BR2_EXTERNAL=/path/to/foobar menuconfig
>  -----
>  
>  From now on, external definitions from the +/path/to/foobar+
>  directory will be used:
>  
>  -----
> - buildroot/ $ make
> - buildroot/ $ make legal-info
> +make
> +make legal-info
>  -----
>  
>  We can switch to another external definitions directory at any time:
>  
>  -----
> - buildroot/ $ make BR2_EXTERNAL=/where/we/have/barfoo xconfig
> +make BR2_EXTERNAL=/where/we/have/barfoo xconfig
>  -----
>  
>  Or disable the usage of external definitions:

Not your fault, but: s/usage/use/

Regards,
Yann E. MORIN.

>  -----
> - buildroot/ $ make BR2_EXTERNAL= xconfig
> +make BR2_EXTERNAL= xconfig
>  -----
>  
>  +BR2_EXTERNAL+ allows three different things:
> -- 
> 2.1.3
> 
> _______________________________________________
> buildroot mailing list
> buildroot@busybox.net
> http://lists.busybox.net/mailman/listinfo/buildroot
diff mbox

Patch

diff --git a/docs/manual/customize-outside-br.txt b/docs/manual/customize-outside-br.txt
index 5d63e60..2b01433 100644
--- a/docs/manual/customize-outside-br.txt
+++ b/docs/manual/customize-outside-br.txt
@@ -30,30 +30,30 @@  but if it's passed as a relative path, it is important to note that it
 is interpreted relative to the main Buildroot source directory, *not*
 to the Buildroot output directory.
 
-Some examples:
+Some examples, assuming you are inside the main Buildroot source directory:
 
 -----
- buildroot/ $ make BR2_EXTERNAL=/path/to/foobar menuconfig
+make BR2_EXTERNAL=/path/to/foobar menuconfig
 -----
 
 From now on, external definitions from the +/path/to/foobar+
 directory will be used:
 
 -----
- buildroot/ $ make
- buildroot/ $ make legal-info
+make
+make legal-info
 -----
 
 We can switch to another external definitions directory at any time:
 
 -----
- buildroot/ $ make BR2_EXTERNAL=/where/we/have/barfoo xconfig
+make BR2_EXTERNAL=/where/we/have/barfoo xconfig
 -----
 
 Or disable the usage of external definitions:
 
 -----
- buildroot/ $ make BR2_EXTERNAL= xconfig
+make BR2_EXTERNAL= xconfig
 -----
 
 +BR2_EXTERNAL+ allows three different things: