[Buildroot] [PATCH] toolchain/crosstool-ng: be more explicit in the config file help

[Buildroot] [PATCH] toolchain/crosstool-ng: be more explicit in the config file help

[Yann E. MORIN]

Some users seem to interpret:
    make ctng-menuconfig

as being a value that can be fit for the ct-ng config file.

Clarify that it is a command to run, not a possible value.

Reported-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
---
 toolchain/toolchain-crosstool-ng/Config.in |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

diff --git a/toolchain/toolchain-crosstool-ng/Config.in b/toolchain/toolchain-crosstool-ng/Config.in
index d80f547..68061f0 100644
--- a/toolchain/toolchain-crosstool-ng/Config.in
+++ b/toolchain/toolchain-crosstool-ng/Config.in
@@ -44,7 +44,8 @@ config BR2_TOOLCHAIN_CTNG_CONFIG
 	default "toolchain/toolchain-crosstool-ng/crosstool-ng.config-glibc"  if BR2_TOOLCHAIN_CTNG_glibc
 	help
 	  Enter here the crosstool-NG's .config file to use.
-	  To fine-tune your toolchain, you can also call:
+	  To fine-tune your toolchain, you may also run (from the
+	  command line) this command:
 	    make ctng-menuconfig
 
 	  If unsure, keep the default value.
-- 
1.7.2.5

[Buildroot] [PATCH] toolchain/crosstool-ng: be more explicit in the config file help

[Thomas Petazzoni]

Dear Yann E. MORIN,

On Wed,  9 Jan 2013 23:22:50 +0100, Yann E. MORIN wrote:

>  	default "toolchain/toolchain-crosstool-ng/crosstool-ng.config-glibc"  if BR2_TOOLCHAIN_CTNG_glibc
>  	help
>  	  Enter here the crosstool-NG's .config file to use.

Enter here the path to the crosstool-NG .config file to use.

> -	  To fine-tune your toolchain, you can also call:
> +	  To fine-tune your toolchain, you may also run (from the
> +	  command line) this command:
>  	    make ctng-menuconfig
>  
>  	  If unsure, keep the default value.

I would insist a bit more here, something along the lines of:

 "Generally, the default crosstool-NG configuration files bundled with
 Buildroot work fine in most situations. Use 'make ctng-menuconfig'
 only for expert customization of your toolchain".

Thomas
-- 
Thomas Petazzoni, Free Electrons
Kernel, drivers, real-time and embedded Linux
development, consulting, training and support.
http://free-electrons.com

[Buildroot] [PATCH] toolchain/crosstool-ng: be more explicit in the config file help

[Yann E. MORIN]

Some users seem to interpret:
    make ctng-menuconfig

as being a value that can be fit for the ct-ng config file.

Clarify that it is a command to run, not a possible value.

Reported-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>

---
Changes v1 -> v2:
  - rework the whole help text with content suggested by Thomas
---
 toolchain/toolchain-crosstool-ng/Config.in |   10 ++++++----
 1 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/toolchain/toolchain-crosstool-ng/Config.in b/toolchain/toolchain-crosstool-ng/Config.in
index d80f547..df4e9b1 100644
--- a/toolchain/toolchain-crosstool-ng/Config.in
+++ b/toolchain/toolchain-crosstool-ng/Config.in
@@ -43,10 +43,12 @@ config BR2_TOOLCHAIN_CTNG_CONFIG
 	default "toolchain/toolchain-crosstool-ng/crosstool-ng.config-eglibc" if BR2_TOOLCHAIN_CTNG_eglibc
 	default "toolchain/toolchain-crosstool-ng/crosstool-ng.config-glibc"  if BR2_TOOLCHAIN_CTNG_glibc
 	help
-	  Enter here the crosstool-NG's .config file to use.
-	  To fine-tune your toolchain, you can also call:
-	    make ctng-menuconfig
-
+	  Enter here the path to the crosstool-NG .config file to use.
+	  
+	  Generally, the default crosstool-NG configuration files bundled with
+	  Buildroot work fine in most situations. Use 'make ctng-menuconfig'
+	  from the command line, for expert customization of your toolchain.
+	  
 	  If unsure, keep the default value.
 
 if BR2_TOOLCHAIN_CTNG_uClibc
-- 
1.7.2.5

[Buildroot] [PATCH] toolchain/crosstool-ng: be more explicit in the config file help

[Peter Korsgaard]

>>>>> "Yann" == Yann E MORIN <yann.morin.1998@free.fr> writes:

 Yann> Some users seem to interpret:
 Yann>     make ctng-menuconfig

 Yann> as being a value that can be fit for the ct-ng config file.

 Yann> Clarify that it is a command to run, not a possible value.

 Yann> Reported-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
 Yann> Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>

Committed, thanks.

-- 
Bye, Peter Korsgaard