Re: [PATCH v2] drm/hwmon: Fix abi doc warnings

["Dixit, Ashutosh" <ashutosh.dixit@intel.com>]

On Mon, 29 Jan 2024 07:18:59 -0800, Lucas De Marchi wrote:
>
> On Sat, Jan 27, 2024 at 12:10:08PM -0800, Ashutosh Dixit wrote:
> > On Sat, 27 Jan 2024 08:50:40 -0800, Badal Nilawar wrote:
> >>
> >
> > Hi Badal,
> >
> >> This fixes warnings in xe, i915 hwmon docs
> >>
> >> Warning: /sys/devices/.../hwmon/hwmon<i>/curr1_crit is defined 2 times:  Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:35  Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:52
> >> Warning: /sys/devices/.../hwmon/hwmon<i>/energy1_input is defined 2 times:  Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:54  Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:65
> >> Warning: /sys/devices/.../hwmon/hwmon<i>/in0_input is defined 2 times:  Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:46  Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:0
> >> Warning: /sys/devices/.../hwmon/hwmon<i>/power1_crit is defined 2 times:  Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:22  Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:39
> >> Warning: /sys/devices/.../hwmon/hwmon<i>/power1_max is defined 2 times:  Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:0  Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:8
> >> Warning: /sys/devices/.../hwmon/hwmon<i>/power1_max_interval is defined 2 times:  Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:62  Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:30
> >> Warning: /sys/devices/.../hwmon/hwmon<i>/power1_rated_max is defined 2 times:  Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:14  Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:22
> >
> > /snip/
> >
> >> diff --git a/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon b/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon
> >> index 8d7d8f05f6cd..92fe7c5c5ac1 100644
> >> --- a/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon
> >> +++ b/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon
> >> @@ -1,4 +1,4 @@
> >> -What:		/sys/devices/.../hwmon/hwmon<i>/in0_input
> >
> > Are the warnings happening because this path doesn't exist?
> >
> >> +What:		/sys/bus/pci/drivers/i915/.../hwmon/hwmon<i>/in0_input
> >
> > So this I guess could also be
> >
> > /sys/class/drm/card<n>/device/hwmon/hwmon<i>/in0_input?
>
> no. the issue is not that it doesn't exist, but that the same path is
> documented in 2 different places. If the interface is exactly the same,
> there could be just 1 place to document it and then reuse the same file
> (without the module name). If the interfaces are not identical, then we
> should differentiate them like is done here.

Ah, got it, thanks!

>
> +i915 maintainers
>
> Are you ok with merging this through either xe or i915 trees
> instead of splitting the patch? My preference is the first option.
>
>
> Reviewed-by: Lucas De Marchi <lucas.demarchi@intel.com>
>
> also tested that this fixes the issue when building docs.
>
> thanks
> Lucas De Marchi
>
> >
> > But no need to change, what you have is also a valid path. But maybe to
> > make clear:
> >
> > /sys/bus/pci/drivers/i915/<device>/hwmon/hwmon<i>/in0_input
> >
> > ?
> >
> > But anyway...
> >
> > Assuming you turned on the htmldoc build option, could reproduce this and
> > verified that this patch is fixing these warnings, this is:
> >
> > Reviewed-by: Ashutosh Dixit <ashutosh.dixit@intel.com>