Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
MIME-Version: 1.0
In-Reply-To: <20171108205643.GB8522@tassilo.jf.intel.com>
References: <1510127797-22483-1-git-send-email-eranian@google.com>
 <1510127797-22483-5-git-send-email-eranian@google.com> <20171108205643.GB8522@tassilo.jf.intel.com>
From:   Stephane Eranian <eranian@google.com>
Date:   Wed, 8 Nov 2017 19:42:28 -0800
Message-ID: <CABPqkBS+WaLfeEox8ZHQhdxz3k45S2qXAPqURecr2V+AKpoHaA@mail.gmail.com>
Subject: Re: [PATCH v3 4/5] perf/record: add documentation for sampling skid ip
To:     Andi Kleen <ak@linux.intel.com>
Cc:     LKML <linux-kernel@vger.kernel.org>,
        Arnaldo Carvalho de Melo <acme@redhat.com>,
        Peter Zijlstra <peterz@infradead.org>, mingo@elte.hu,
        "Liang, Kan" <kan.liang@intel.com>, Jiri Olsa <jolsa@redhat.com>
Content-Type: text/plain; charset="UTF-8"
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

On Wed, Nov 8, 2017 at 12:56 PM, Andi Kleen <ak@linux.intel.com> wrote:
>> diff --git a/tools/perf/Documentation/perf-record.txt b/tools/perf/Documentation/perf-record.txt
>> index 5a626ef666c2..3b156fa03c99 100644
>> --- a/tools/perf/Documentation/perf-record.txt
>> +++ b/tools/perf/Documentation/perf-record.txt
>> @@ -57,6 +57,14 @@ OPTIONS
>>                        FP mode, "dwarf" for DWARF mode, "lbr" for LBR mode and
>>                        "no" for disable callgraph.
>>         - 'stack-size': user stack size for dwarf mode
>> +       - 'skid_ip' : boolean, captures the unmodified interrupt instruction pointer
>> +                     (IP) in each sample. Usually with event-based sampling, the IP
>> +                     has skid and rarely point to the instruction which caused the
>> +                     event to overflow. On some architectures, the hardware can eliminate
>> +                     the skid and perf_events returns it as the IP with precise sampling is
>> +                     enabled. But for certain measurements, it may be useful to have both
>> +                     the correct and skid ip. This option enable capturing the skid ip in
>> +                     additional to the corrected ip. Default is: false
>
> Actually in the scanner you use 'skid-ip' (with minus). Documentation should at least match
> the scanner.
>
I have fixed the documentation. I used - because many other terms and
options use - instead of _.

> _ is usually safer than -
>
I tend to agree with you.

> -Andi

From 1583533108128519198@xxx Wed Nov 08 21:00:54 +0000 2017
X-GM-THRID: 1583483886934922232
X-Gmail-Labels: Inbox,Category Forums,HistoricalUnread