On Fri, May 05, 2023 at 11:34:51AM +0700, Bagas Sanjaya wrote: > 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 strongly >> - 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 chip >> + lives at an address which can't be probed, then the device will have to 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. Specifically, >> completely initialize your chip and your driver first, then register with >> - the hwmon subsystem. >> + the ``hwmon`` subsystem. > > Also here. > >> >> -* Use devm_hwmon_device_register_with_info() or, if your driver needs a remove >> - function, hwmon_device_register_with_info() 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 deprecated registration functions. >> +* Use >> + :ref:`devm_hwmon_device_register_with_info() <devm_hwmon_device_register_with_info>` >> + or, if your driver needs a remove function, >> + :ref:`hwmon_device_register_with_info() <hwmon_device_register_with_info>` 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 deprecated >> + 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. > > -- > An old man doll... just what I always wanted! - Clara Good point. I will remove inline references to hwmon and sysfs.
