Message ID | 20200105225012.11701-23-luca@lucaceresoli.net |
---|---|
State | Changes Requested |
Headers | show |
Series | docs: i2c: rework I2C documentation, part I | expand |
On Sun, 5 Jan 2020 23:50:09 +0100, Luca Ceresoli wrote: > Use ReST syntax so that a proper hyperlink is generated. > > Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> > --- > Documentation/i2c/old-module-parameters.rst | 3 +-- > 1 file changed, 1 insertion(+), 2 deletions(-) > > diff --git a/Documentation/i2c/old-module-parameters.rst b/Documentation/i2c/old-module-parameters.rst > index 78a6950e5763..0503d2f0b127 100644 > --- a/Documentation/i2c/old-module-parameters.rst > +++ b/Documentation/i2c/old-module-parameters.rst > @@ -12,8 +12,7 @@ address), "force" (to forcibly attach the driver to a given device) and > With the conversion of the I2C subsystem to the standard device driver > binding model, it became clear that these per-module parameters were no > longer needed, and that a centralized implementation was possible. The new, > -sysfs-based interface is described in the documentation file > -"instantiating-devices", section "Method 4: Instantiate from user-space". > +sysfs-based interface is described in :doc:`instantiating-devices`. I object to removing the reference to the section. I think this is saving the reader some time so it is valuable. > > Below is a mapping from the old module parameters to the new interface. > Reviewed-by: Jean Delvare <jdelvare@suse.de>
Hi Jean, On 22/01/20 11:16, Jean Delvare wrote: > On Sun, 5 Jan 2020 23:50:09 +0100, Luca Ceresoli wrote: >> Use ReST syntax so that a proper hyperlink is generated. >> >> Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> >> --- >> Documentation/i2c/old-module-parameters.rst | 3 +-- >> 1 file changed, 1 insertion(+), 2 deletions(-) >> >> diff --git a/Documentation/i2c/old-module-parameters.rst b/Documentation/i2c/old-module-parameters.rst >> index 78a6950e5763..0503d2f0b127 100644 >> --- a/Documentation/i2c/old-module-parameters.rst >> +++ b/Documentation/i2c/old-module-parameters.rst >> @@ -12,8 +12,7 @@ address), "force" (to forcibly attach the driver to a given device) and >> With the conversion of the I2C subsystem to the standard device driver >> binding model, it became clear that these per-module parameters were no >> longer needed, and that a centralized implementation was possible. The new, >> -sysfs-based interface is described in the documentation file >> -"instantiating-devices", section "Method 4: Instantiate from user-space". >> +sysfs-based interface is described in :doc:`instantiating-devices`. > > I object to removing the reference to the section. I think this is > saving the reader some time so it is valuable. I agree, re-added in v2.
diff --git a/Documentation/i2c/old-module-parameters.rst b/Documentation/i2c/old-module-parameters.rst index 78a6950e5763..0503d2f0b127 100644 --- a/Documentation/i2c/old-module-parameters.rst +++ b/Documentation/i2c/old-module-parameters.rst @@ -12,8 +12,7 @@ address), "force" (to forcibly attach the driver to a given device) and With the conversion of the I2C subsystem to the standard device driver binding model, it became clear that these per-module parameters were no longer needed, and that a centralized implementation was possible. The new, -sysfs-based interface is described in the documentation file -"instantiating-devices", section "Method 4: Instantiate from user-space". +sysfs-based interface is described in :doc:`instantiating-devices`. Below is a mapping from the old module parameters to the new interface.
Use ReST syntax so that a proper hyperlink is generated. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> --- Documentation/i2c/old-module-parameters.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)