Re: [RFC 08/11] Documentation/hwmon: Revise userspace tools documentation

[Guenter Roeck]

On 5/5/23 08:12, James Seo wrote:
> On Fri, May 05, 2023 at 12:03:29PM +0700, Bagas Sanjaya wrote:
> > On Thu, May 04, 2023 at 12:57:49AM -0700, James Seo wrote:
> > > +If needed, sources may be found at https://hwmon.wiki.kernel.org/lm_sensors.
> > > +Basic compilation, installation, and uninstallation may be accomplished with
> > > +``make all``, ``make install``, and ``make uninstall``, respectively.
> > > +
> >
> > The sources is on GitHub:

Above page has a "Download" link which points to the github repository.
Personally I think it is better to have a reference to a more generic
location such as to kernel.org in the kenrel and point to the
actual repository (which is more likely to change, after all)
from there.

Guenter

> > ---- >8 ----
> > diff --git a/Documentation/hwmon/userspace-tools.rst b/Documentation/hwmon/userspace-tools.rst
> > index 79c932954e4af5..fd96ea92f72eea 100644
> > --- a/Documentation/hwmon/userspace-tools.rst
> > +++ b/Documentation/hwmon/userspace-tools.rst
> > @@ -44,9 +44,9 @@ Most Linux distributions provide the ``lm-sensors`` suite as a package.
> >   It is recommended that you use this package for ease of installation.
> >   Please consult your Linux distribution's documentation for more information.
> >   
> > -If needed, sources may be found at https://hwmon.wiki.kernel.org/lm_sensors.
> > -Basic compilation, installation, and uninstallation may be accomplished with
> > -``make all``, ``make install``, and ``make uninstall``, respectively.
> > +If the distribution package isn't available, sources can be obtained at
> > +`GitHub <https://github.com/lm-sensors/lm-sensors>`_.
> > +See ``INSTALL`` in the sources for how to build the suite.
> >   
> >   Usage
> >   -----
> >
> > Thanks.
> >
> > --
> > An old man doll... just what I always wanted! - Clara
>
> The document previously mentioned the old official lm-sensors site,
> so I thought I should mention the current one, which has a GitHub link
> anyway. But I will change this and add a link to the current site
> separately.
>
> Thanks.
>
> James