Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Fri, 5 May 2023 11:34:51 +0700
From:   Bagas Sanjaya <bagasdotme@gmail.com>
To:     James Seo <james@equiv.tech>, Jean Delvare <jdelvare@suse.com>,
        Guenter Roeck <linux@roeck-us.net>,
        Jonathan Corbet <corbet@lwn.net>
Cc:     linux-hwmon@vger.kernel.org, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org
Subject: Re: [RFC 06/11] Documentation/hwmon: Revise patch submission
 checklist
Message-ID: <ZFSHa2ThLorH5fwI@debian.me>
References: <20230504075752.1320967-1-james@equiv.tech>
 <20230504075752.1320967-7-james@equiv.tech>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
        protocol="application/pgp-signature"; boundary="25CJpLEImxGsf4/m"
Content-Disposition: inline
In-Reply-To: <20230504075752.1320967-7-james@equiv.tech>
Precedence: bulk


--25CJpLEImxGsf4/m
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Thu, May 04, 2023 at 12:57:47AM -0700, James Seo wrote:
> -* Only the following I2C addresses shall be probed: 0x18-0x1f, 0x28-0x2f,
> -  0x48-0x4f, 0x58, 0x5c, 0x73 and 0x77. Probing other addresses is stron=
gly
> -  discouraged as it is known to cause trouble with other (non-hwmon) I2C
> -  chips. If your chip lives at an address which can't be probed then the
> -  device will have to be instantiated explicitly (which is always better
> -  anyway.)
> +* Only the following I2C addresses shall be probed: ``0x18``-``0x1f``,
> +  ``0x28``-``0x2f``, ``0x48``-``0x4f``, ``0x58``, ``0x5c``, ``0x73``,
> +  and ``0x77``. Probing other addresses is strongly discouraged, as it is
> +  known to cause trouble with other (non-``hwmon``) I2C chips. If your c=
hip
> +  lives at an address which can't be probed, then the device will have t=
o be
> +  instantiated explicitly (which is always better anyway).

IMO hwmon here refers to the subsystem (not code identifier name), so
inlining here isn't needed.

>  * Make sure there are no race conditions in the probe function. Specific=
ally,
>    completely initialize your chip and your driver first, then register w=
ith
> -  the hwmon subsystem.
> +  the ``hwmon`` subsystem.

Also here.

> =20
> -* Use devm_hwmon_device_register_with_info() or, if your driver needs a =
remove
> -  function, hwmon_device_register_with_info() to register your driver wi=
th the
> -  hwmon subsystem. Try using devm_add_action() instead of a remove funct=
ion if
> -  possible. Do not use any of the deprecated registration functions.
> +* Use
> +  :ref:`devm_hwmon_device_register_with_info() <devm_hwmon_device_regist=
er_with_info>`
> +  or, if your driver needs a remove function,
> +  :ref:`hwmon_device_register_with_info() <hwmon_device_register_with_in=
fo>` to
> +  register your driver with the ``hwmon`` subsystem. Try using devm_add_=
action()
> +  instead of a remove function if possible. Do not use any of the deprec=
ated
> +  registration functions.

And here.

> -* Do not provide support for deprecated sysfs attributes.
> +* Do not provide support for deprecated ``sysfs`` attributes.

Dunno if sysfs (as subsystem name) also needs to be inlined.

Thanks.

--=20
An old man doll... just what I always wanted! - Clara

--25CJpLEImxGsf4/m
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iHUEABYKAB0WIQSSYQ6Cy7oyFNCHrUH2uYlJVVFOowUCZFSHawAKCRD2uYlJVVFO
o7XUAQDfbXg0sNIzBhhokOCsjuDlTw0Q1vvP6BPSPrANQc4q1wEAxQFd/Qvkmlwr
iM5HwGpAQ77fNQV02hQ5lQyGndcCoAk=
=GUrd
-----END PGP SIGNATURE-----

--25CJpLEImxGsf4/m--