Re: [PATCH RFC 1/3] perf: script: Fix documentation of '-f' when it should be '-F'

[Arnaldo Carvalho de Melo]

Em Thu, Jun 16, 2016 at 03:34:32PM +0300, Adrian Hunter escreveu:
> The documentation for perf script mixes up '-f' and '-F'. Fix it.

Applied, thanks,

- Arnaldo

> Signed-off-by: Adrian Hunter <adrian.hunter@xxxxxxxxx>
> ---
>  tools/perf/Documentation/perf-script.txt | 20 ++++++++++----------
>  1 file changed, 10 insertions(+), 10 deletions(-)
> 
> diff --git a/tools/perf/Documentation/perf-script.txt b/tools/perf/Documentation/perf-script.txt
> index 4fc44c75263f..4f34379ebd77 100644
> --- a/tools/perf/Documentation/perf-script.txt
> +++ b/tools/perf/Documentation/perf-script.txt
> @@ -119,13 +119,13 @@ OPTIONS
>  	srcline, period, iregs, brstack, brstacksym, flags.
>          Field list can be prepended with the type, trace, sw or hw,
>          to indicate to which event type the field list applies.
> -        e.g., -f sw:comm,tid,time,ip,sym  and -f trace:time,cpu,trace
> +        e.g., -F sw:comm,tid,time,ip,sym  and -F trace:time,cpu,trace
>  
> -		perf script -f <fields>
> +		perf script -F <fields>
>  
>  	is equivalent to:
>  
> -		perf script -f trace:<fields> -f sw:<fields> -f hw:<fields>
> +		perf script -F trace:<fields> -F sw:<fields> -F hw:<fields>
>  
>  	i.e., the specified fields apply to all event types if the type string
>  	is not given.
> @@ -133,9 +133,9 @@ OPTIONS
>  	The arguments are processed in the order received. A later usage can
>  	reset a prior request. e.g.:
>  
> -		-f trace: -f comm,tid,time,ip,sym
> +		-F trace: -F comm,tid,time,ip,sym
>  
> -	The first -f suppresses trace events (field list is ""), but then the
> +	The first -F suppresses trace events (field list is ""), but then the
>  	second invocation sets the fields to comm,tid,time,ip,sym. In this case a
>  	warning is given to the user:
>  
> @@ -143,9 +143,9 @@ OPTIONS
>  
>  	Alternatively, consider the order:
>  
> -		-f comm,tid,time,ip,sym -f trace:
> +		-F comm,tid,time,ip,sym -F trace:
>  
> -	The first -f sets the fields for all events and the second -f
> +	The first -F sets the fields for all events and the second -F
>  	suppresses trace events. The user is given a warning message about
>  	the override, and the result of the above is that only S/W and H/W
>  	events are displayed with the given fields.
> @@ -154,14 +154,14 @@ OPTIONS
>  	event type, a message is displayed to the user that the option is
>  	ignored for that type. For example:
>  
> -		$ perf script -f comm,tid,trace
> +		$ perf script -F comm,tid,trace
>  		'trace' not valid for hardware events. Ignoring.
>  		'trace' not valid for software events. Ignoring.
>  
>  	Alternatively, if the type is given an invalid field is specified it
>  	is an error. For example:
>  
> -        perf script -v -f sw:comm,tid,trace
> +        perf script -v -F sw:comm,tid,trace
>          'trace' not valid for software events.
>  
>  	At this point usage is displayed, and perf-script exits.
> @@ -173,7 +173,7 @@ OPTIONS
>  	respectively.
>  
>  	Finally, a user may not set fields to none for all event types.
> -	i.e., -f "" is not allowed.
> +	i.e., -F "" is not allowed.
>  
>  	The brstack output includes branch related information with raw addresses using the
>  	/v/v/v/v/ syntax in the following order:
> -- 
> 1.9.1