[PATCH v2] Consistent variable name make less confusion

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

[PATCH v2] Consistent variable name make less confusion

Cao jin
When @node "call Function" is outputted in Info format, there are inconsistent
inconsistent variable names between example and description. @var is used to
indicate metasyntactic variables, and will change the case of the argument to
all uppercase in Info file. @code is more suitable in this case.

Signed-off-by: Cao jin <[hidden email]>
---
 doc/make.texi | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/make.texi b/doc/make.texi
index 343927b..57c8806 100644
--- a/doc/make.texi
+++ b/doc/make.texi
@@ -7655,7 +7655,7 @@ foo = $(call reverse,a,b)
 @end smallexample
 
 @noindent
-Here @var{foo} will contain @samp{b a}.
+Here @code{foo} will contain @samp{b a}.
 
 This one is slightly more interesting: it defines a macro to search for
 the first instance of a program in @code{PATH}:
@@ -7667,7 +7667,7 @@ LS := $(call pathsearch,ls)
 @end smallexample
 
 @noindent
-Now the variable LS contains @code{/bin/ls} or similar.
+Now the variable @code{LS} contains @code{/bin/ls} or similar.
 
 The @code{call} function can be nested.  Each recursive invocation gets
 its own local values for @code{$(1)}, etc.@: that mask the values of
@@ -7678,14 +7678,14 @@ higher-level @code{call}.  For example, here is an implementation of a
 map = $(foreach a,$(2),$(call $(1),$(a)))
 @end smallexample
 
-Now you can @var{map} a function that normally takes only one argument,
+Now you can @code{map} a function that normally takes only one argument,
 such as @code{origin}, to multiple values in one step:
 
 @smallexample
 o = $(call map,origin,o map MAKE)
 @end smallexample
 
-and end up with @var{o} containing something like @samp{file file default}.
+and end up with @code{o} containing something like @samp{file file default}.
 
 A final caution: be careful when adding whitespace to the arguments to
 @code{call}.  As with other functions, any whitespace contained in the
--
2.1.0




_______________________________________________
Bug-make mailing list
[hidden email]
https://lists.gnu.org/mailman/listinfo/bug-make
Reply | Threaded
Open this post in threaded view
|

Re: [PATCH v2] Consistent variable name make less confusion

Cao jin
Could I know why it got ignored?
--
Sincerely,
Cao jin

On 06/27/2017 03:49 PM, Cao jin wrote:

> When @node "call Function" is outputted in Info format, there are inconsistent
> inconsistent variable names between example and description. @var is used to
> indicate metasyntactic variables, and will change the case of the argument to
> all uppercase in Info file. @code is more suitable in this case.
>
> Signed-off-by: Cao jin <[hidden email]>
> ---
>  doc/make.texi | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/doc/make.texi b/doc/make.texi
> index 343927b..57c8806 100644
> --- a/doc/make.texi
> +++ b/doc/make.texi
> @@ -7655,7 +7655,7 @@ foo = $(call reverse,a,b)
>  @end smallexample
>  
>  @noindent
> -Here @var{foo} will contain @samp{b a}.
> +Here @code{foo} will contain @samp{b a}.
>  
>  This one is slightly more interesting: it defines a macro to search for
>  the first instance of a program in @code{PATH}:
> @@ -7667,7 +7667,7 @@ LS := $(call pathsearch,ls)
>  @end smallexample
>  
>  @noindent
> -Now the variable LS contains @code{/bin/ls} or similar.
> +Now the variable @code{LS} contains @code{/bin/ls} or similar.
>  
>  The @code{call} function can be nested.  Each recursive invocation gets
>  its own local values for @code{$(1)}, etc.@: that mask the values of
> @@ -7678,14 +7678,14 @@ higher-level @code{call}.  For example, here is an implementation of a
>  map = $(foreach a,$(2),$(call $(1),$(a)))
>  @end smallexample
>  
> -Now you can @var{map} a function that normally takes only one argument,
> +Now you can @code{map} a function that normally takes only one argument,
>  such as @code{origin}, to multiple values in one step:
>  
>  @smallexample
>  o = $(call map,origin,o map MAKE)
>  @end smallexample
>  
> -and end up with @var{o} containing something like @samp{file file default}.
> +and end up with @code{o} containing something like @samp{file file default}.
>  
>  A final caution: be careful when adding whitespace to the arguments to
>  @code{call}.  As with other functions, any whitespace contained in the
>





_______________________________________________
Bug-make mailing list
[hidden email]
https://lists.gnu.org/mailman/listinfo/bug-make
Reply | Threaded
Open this post in threaded view
|

Re: [PATCH v2] Consistent variable name make less confusion

Paul Smith-20
On Mon, 2017-07-24 at 14:03 +0800, Cao jin wrote:
> Could I know why it got ignored?

Not ignored... queued!

These changes will be in the next release.  Thanks for the help!

_______________________________________________
Bug-make mailing list
[hidden email]
https://lists.gnu.org/mailman/listinfo/bug-make