[PATCH] perf tools: Fix syntax in documentation of intel-pt config option

[PATCH] perf tools: Fix syntax in documentation of intel-pt config option

[Jack Henschel]

As specified in tools/perf/Documentation/perf-config.txt, perf
configuration items must be in 'key = value' format, otherwise the
following error message occurs:

$ perf record -e intel_pt//u -- ls
bad config file line 2 in ~/.perfconfig
$ cat .perfconfig
[intel-pt]
    mispred-all

Changing assigning a value to the key 'mispred-all' fixes the issue:
$ perf record -e intel_pt//u -- ls
[ perf record: Woken up 1 times to write data ]
[ perf record: Capured and wrote 0.031 MB perf.data]
$ cat .perfconfig
[intel-pt]
    mispred-all = true
---
 tools/perf/Documentation/intel-pt.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/perf/Documentation/intel-pt.txt b/tools/perf/Documentation/intel-pt.txt
index 4b6cdbf8f935..a47d845b9b61 100644
--- a/tools/perf/Documentation/intel-pt.txt
+++ b/tools/perf/Documentation/intel-pt.txt
@@ -873,7 +873,7 @@ amended to take the number of elements as a parameter.
 
 	$ cat ~/.perfconfig
 	[intel-pt]
-		mispred-all
+		mispred-all = on
 
 	$ perf record -e intel_pt//u ./sort 3000
 	Bubble sorting array of 3000 elements
-- 
2.14.1

Re: [PATCH] perf tools: Fix syntax in documentation of intel-pt config option

[Arnaldo Carvalho de Melo]

Em Thu, Aug 31, 2017 at 10:05:35AM +0200, Jack Henschel escreveu:
> As specified in tools/perf/Documentation/perf-config.txt, perf
> configuration items must be in 'key = value' format, otherwise the
> following error message occurs:
> 
> $ perf record -e intel_pt//u -- ls
> bad config file line 2 in ~/.perfconfig
> $ cat .perfconfig
> [intel-pt]
>     mispred-all
> 
> Changing assigning a value to the key 'mispred-all' fixes the issue:
> $ perf record -e intel_pt//u -- ls
> [ perf record: Woken up 1 times to write data ]
> [ perf record: Capured and wrote 0.031 MB perf.data]
> $ cat .perfconfig
> [intel-pt]
>     mispred-all = true

You forgot to add your:

Signed-off-by: Jack Henschel <jackdev@mailbox.org>

I'm assuming you intended it, so I'm adding it to my local repository,
please ack this.

- Arnaldo

> ---
>  tools/perf/Documentation/intel-pt.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/tools/perf/Documentation/intel-pt.txt b/tools/perf/Documentation/intel-pt.txt
> index 4b6cdbf8f935..a47d845b9b61 100644
> --- a/tools/perf/Documentation/intel-pt.txt
> +++ b/tools/perf/Documentation/intel-pt.txt
> @@ -873,7 +873,7 @@ amended to take the number of elements as a parameter.
>  
>  	$ cat ~/.perfconfig
>  	[intel-pt]
> -		mispred-all
> +		mispred-all = on
>  
>  	$ perf record -e intel_pt//u ./sort 3000
>  	Bubble sorting array of 3000 elements
> -- 
> 2.14.1

[tip:perf/urgent] perf intel-pt: Fix syntax in documentation of config option

[tip-bot for Jack Henschel]

Commit-ID:  4fb205392022ba99a45dd01a62c6e2df046e400a
Gitweb:     http://git.kernel.org/tip/4fb205392022ba99a45dd01a62c6e2df046e400a
Author:     Jack Henschel <jackdev@mailbox.org>
AuthorDate: Thu, 31 Aug 2017 10:05:35 +0200
Committer:  Arnaldo Carvalho de Melo <acme@redhat.com>
CommitDate: Fri, 1 Sep 2017 14:45:59 -0300

perf intel-pt: Fix syntax in documentation of config option

As specified in tools/perf/Documentation/perf-config.txt, perf
configuration items must be in 'key = value' format, otherwise the
following error message occurs:

  $ perf record -e intel_pt//u -- ls
  bad config file line 2 in ~/.perfconfig
  $ cat .perfconfig
  [intel-pt]
      mispred-all

Changing to assigning a value to the key 'mispred-all' fixes the issue:

  $ perf record -e intel_pt//u -- ls
  [ perf record: Woken up 1 times to write data ]
  [ perf record: Capured and wrote 0.031 MB perf.data]
  $ cat .perfconfig
  [intel-pt]
      mispred-all = true

Signed-off-by: Jack Henschel <jackdev@mailbox.org>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Link: http://lkml.kernel.org/r/20170831080535.2157-1-jackdev@mailbox.org
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
---
 tools/perf/Documentation/intel-pt.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/perf/Documentation/intel-pt.txt b/tools/perf/Documentation/intel-pt.txt
index ab1b082..76971d2 100644
--- a/tools/perf/Documentation/intel-pt.txt
+++ b/tools/perf/Documentation/intel-pt.txt
@@ -873,7 +873,7 @@ amended to take the number of elements as a parameter.
 
 	$ cat ~/.perfconfig
 	[intel-pt]
-		mispred-all
+		mispred-all = on
 
 	$ perf record -e intel_pt//u ./sort 3000
 	Bubble sorting array of 3000 elements