[PATCH v7 7/7] powerpc/perf/hv-24x7: Document sysfs event description entries

[Cody P Schafer]

On Fri, Jan 30, 2015 at 4:46 PM, Sukadev Bhattiprolu
<sukadev at linux.vnet.ibm.com> wrote:
> From: Cody P Schafer <cody at linux.vnet.ibm.com>
>
> Signed-off-by: Cody P Schafer <cody at linux.vnet.ibm.com>
> Signed-off-by: Sukadev Bhattiprolu <sukadev at linux.vnet.ibm.com>
> ---
> Changelog[v6]
>         Update Contact info to Linux on Power Developer list
>
>  .../testing/sysfs-bus-event_source-devices-hv_24x7 | 22 ++++++++++++++++++++++
>  1 file changed, 22 insertions(+)
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_24x7 b/Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_24x7
> index 32f3f5f..f893337 100644
> --- a/Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_24x7
> +++ b/Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_24x7
> @@ -21,3 +21,25 @@ Contact:     Linux on PowerPC Developer List <linuxppc-dev at lists.ozlabs.org>
>  Description:
>                 Exposes the "version" field of the 24x7 catalog. This is also
>                 extractable from the provided binary "catalog" sysfs entry.
> +
> +What:          /sys/bus/event_source/devices/hv_24x7/event_descs/<event-name>
> +Date:          February 2014
> +Contact:       Linux on PowerPC Developer List <linuxppc-dev at lists.ozlabs.org>
> +Description:
> +               Provides the description of a particular event as provided by
> +               the firmware. If firmware does not provide a description, no
> +               file will be created.
> +
> +               Note that the event-name lacks the domain suffix appended for
> +               events in the events/ dir.

I'm probably a bit late on this, but:

Please consider removing the need for a user to know about the "domain
suffixes" (which, as far as I know are 24x7 specific).
If anyone else ever wants to add firmware/hardware/kernel provided
event descriptions, they'll need to special case these ones as they
don't match up with the actual event names.