| Message ID | 20200106074654.13842-1-luca@lucaceresoli.net |
|---|---|
| State | Changes Requested |
| Headers | show |
| Series | docs: i2c: rework I2C documentation, part I | expand |
On Mon, 6 Jan 2020 08:46:54 +0100, Luca Ceresoli wrote: > Use a monospace (literal) formatting for better readability of filenames. This description and the subject are confusing. The strings you are formatting are not filenames. They may be visible as sysfs attributes and thus correspond to a filename, but primarily they are module parameters and I2C client names. > > Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> > --- > Documentation/i2c/old-module-parameters.rst | 10 +++++----- > 1 file changed, 5 insertions(+), 5 deletions(-) > > diff --git a/Documentation/i2c/old-module-parameters.rst b/Documentation/i2c/old-module-parameters.rst > index 80fb117883fd..fdc470a5f999 100644 > --- a/Documentation/i2c/old-module-parameters.rst > +++ b/Documentation/i2c/old-module-parameters.rst > @@ -10,9 +10,9 @@ I2C device driver binding control from user-space > Up to kernel 2.6.32, many I2C drivers used helper macros provided by > <linux/i2c.h> which created standard module parameters to let the user > control how the driver would probe I2C buses and attach to devices. These > -parameters were known as "probe" (to let the driver probe for an extra > -address), "force" (to forcibly attach the driver to a given device) and > -"ignore" (to prevent a driver from probing a given address). > +parameters were known as ``probe`` (to let the driver probe for an extra > +address), ``force`` (to forcibly attach the driver to a given device) and > +``ignore`` (to prevent a driver from probing a given address). > > With the conversion of the I2C subsystem to the standard device driver > binding model, it became clear that these per-module parameters were no > @@ -46,8 +46,8 @@ New method (sysfs interface):: > # echo dummy 0x2f > /sys/bus/i2c/devices/i2c-1/new_device > # modprobe <driver> > > -Of course, it is important to instantiate the "dummy" device before loading > +Of course, it is important to instantiate the ``dummy`` device before loading > the driver. The dummy device will be handled by i2c-core itself, preventing > other drivers from binding to it later on. If there is a real device at the > problematic address, and you want another driver to bind to it, then simply > -pass the name of the device in question instead of "dummy". > +pass the name of the device in question instead of ``dummy``. Reviewed-by: Jean Delvare <jdelvare@suse.de>
diff --git a/Documentation/i2c/old-module-parameters.rst b/Documentation/i2c/old-module-parameters.rst index 80fb117883fd..fdc470a5f999 100644 --- a/Documentation/i2c/old-module-parameters.rst +++ b/Documentation/i2c/old-module-parameters.rst @@ -10,9 +10,9 @@ I2C device driver binding control from user-space Up to kernel 2.6.32, many I2C drivers used helper macros provided by <linux/i2c.h> which created standard module parameters to let the user control how the driver would probe I2C buses and attach to devices. These -parameters were known as "probe" (to let the driver probe for an extra -address), "force" (to forcibly attach the driver to a given device) and -"ignore" (to prevent a driver from probing a given address). +parameters were known as ``probe`` (to let the driver probe for an extra +address), ``force`` (to forcibly attach the driver to a given device) and +``ignore`` (to prevent a driver from probing a given address). With the conversion of the I2C subsystem to the standard device driver binding model, it became clear that these per-module parameters were no @@ -46,8 +46,8 @@ New method (sysfs interface):: # echo dummy 0x2f > /sys/bus/i2c/devices/i2c-1/new_device # modprobe <driver> -Of course, it is important to instantiate the "dummy" device before loading +Of course, it is important to instantiate the ``dummy`` device before loading the driver. The dummy device will be handled by i2c-core itself, preventing other drivers from binding to it later on. If there is a real device at the problematic address, and you want another driver to bind to it, then simply -pass the name of the device in question instead of "dummy". +pass the name of the device in question instead of ``dummy``.
Use a monospace (literal) formatting for better readability of filenames. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> --- Documentation/i2c/old-module-parameters.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)