linux-i2c.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Luca Ceresoli <luca@lucaceresoli.net>
To: linux-i2c@vger.kernel.org, linux-doc@vger.kernel.org
Cc: Luca Ceresoli <luca@lucaceresoli.net>,
	Wolfram Sang <wsa@the-dreams.de>, Jean Delvare <jdelvare@suse.de>,
	Peter Rosin <peda@axentia.se>,
	linux-kernel@vger.kernel.org
Subject: [PATCH v2 22/28] docs: i2c: instantiating-devices: use monospace for sysfs attributes
Date: Thu, 23 Jan 2020 15:56:20 +0100	[thread overview]
Message-ID: <20200123145626.8102-9-luca@lucaceresoli.net> (raw)
In-Reply-To: <20200123145626.8102-1-luca@lucaceresoli.net>

Use a monospace (literal) formatting for better readability of sysfs
attributes.

Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
Reviewed-by: Jean Delvare <jdelvare@suse.de>

---

Changes in v2:
 - reword commit message to not mention filenames
---
 Documentation/i2c/instantiating-devices.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/Documentation/i2c/instantiating-devices.rst b/Documentation/i2c/instantiating-devices.rst
index 665bf00792ba..e558e0a77e0c 100644
--- a/Documentation/i2c/instantiating-devices.rst
+++ b/Documentation/i2c/instantiating-devices.rst
@@ -225,15 +225,15 @@ In general, the kernel should know which I2C devices are connected and
 what addresses they live at. However, in certain cases, it does not, so a
 sysfs interface was added to let the user provide the information. This
 interface is made of 2 attribute files which are created in every I2C bus
-directory: new_device and delete_device. Both files are write only and you
-must write the right parameters to them in order to properly instantiate,
-respectively delete, an I2C device.
+directory: ``new_device`` and ``delete_device``. Both files are write
+only and you must write the right parameters to them in order to properly
+instantiate, respectively delete, an I2C device.
 
-File new_device takes 2 parameters: the name of the I2C device (a string)
-and the address of the I2C device (a number, typically expressed in
-hexadecimal starting with 0x, but can also be expressed in decimal.)
+File ``new_device`` takes 2 parameters: the name of the I2C device (a
+string) and the address of the I2C device (a number, typically expressed
+in hexadecimal starting with 0x, but can also be expressed in decimal.)
 
-File delete_device takes a single parameter: the address of the I2C
+File ``delete_device`` takes a single parameter: the address of the I2C
 device. As no two devices can live at the same address on a given I2C
 segment, the address is sufficient to uniquely identify the device to be
 deleted.
-- 
2.25.0

  parent reply	other threads:[~2020-01-23 14:56 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-01-23 13:50 [PATCH v2 00/28] docs: i2c: rework I2C documentation, part I Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 01/28] docs: i2c: sort index logically Luca Ceresoli
2020-01-24 12:35   ` Jean Delvare
2020-01-29 12:22     ` Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 02/28] docs: i2c: summary: extend introduction Luca Ceresoli
2020-01-24 13:24   ` Jean Delvare
2020-01-23 13:50 ` [PATCH v2 03/28] docs: i2c: summary: rewrite the "terminology" section Luca Ceresoli
2020-01-24 13:28   ` Jean Delvare
2020-01-23 13:50 ` [PATCH v2 04/28] docs: i2c: call it "I2C" consistently Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 05/28] docs: i2c: fix typo Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 06/28] docs: i2c: replace "I2C-transfer" -> "I2C transfer" consistently Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 07/28] docs: i2c: i2c-protocol: fix kernel-doc function syntax Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 08/28] docs: i2c: i2c-protocol: properly name start and stop conditions Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 09/28] docs: i2c: i2c-protocol: remove unneeded colons from table Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 10/28] docs: i2c: i2c-protocol: use proper names for ACK and NACK Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 11/28] docs: i2c: smbus: fix link syntax Luca Ceresoli
2020-01-24 14:57   ` Jean Delvare
2020-01-23 13:50 ` [PATCH v2 12/28] docs: i2c: smbus-protocol: properly name start and stop conditions Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 13/28] docs: i2c: smbus-protocol: remove unneeded colons from table Luca Ceresoli
2020-01-23 14:56 ` [PATCH v2 14/28] docs: i2c: smbus-protocol: use proper names for ACK and NACK Luca Ceresoli
2020-01-23 14:56   ` [PATCH v2 15/28] docs: i2c: smbus-protocol: enable kernel-doc function syntax Luca Ceresoli
2020-01-23 14:56   ` [PATCH v2 16/28] docs: i2c: smbus-protocol: fix " Luca Ceresoli
2020-01-23 14:56   ` [PATCH v2 17/28] docs: i2c: smbus-protocol: fix typo Luca Ceresoli
2020-01-23 14:56   ` [PATCH v2 18/28] docs: i2c: smbus-protocol: fix punctuation Luca Ceresoli
2020-01-23 14:56   ` [PATCH v2 19/28] docs: i2c: smbus-protocol: improve I2C Block transactions description Luca Ceresoli
2020-01-23 14:56   ` [PATCH v2 20/28] docs: i2c: instantiating-devices: fix internal hyperlink Luca Ceresoli
2020-01-23 14:56   ` [PATCH v2 21/28] docs: i2c: instantiating-devices: rearrange static instatiation Luca Ceresoli
2020-01-23 14:56   ` Luca Ceresoli [this message]
2020-01-23 14:56   ` [PATCH v2 23/28] docs: i2c: old-module-parameters: fix internal hyperlink Luca Ceresoli
2020-01-23 14:56   ` [PATCH v2 24/28] docs: i2c: old-module-parameters: clarify this is for obsolete kernels Luca Ceresoli
2020-01-23 14:56   ` [PATCH v2 25/28] docs: i2c: old-module-parameters: use monospace instead of "" Luca Ceresoli
2020-01-23 14:56   ` [PATCH v2 26/28] docs: i2c: rename sections so the overall picture is clearer Luca Ceresoli
2020-01-23 14:56   ` [PATCH v2 27/28] docs: i2c: i2c-protocol: use same wording as smbus-protocol Luca Ceresoli
2020-01-24 15:59     ` Jean Delvare
2020-01-23 14:56   ` [PATCH v2 28/28] docs: i2c: writing-clients: properly name the stop condition Luca Ceresoli
2020-01-24 16:01     ` Jean Delvare

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200123145626.8102-9-luca@lucaceresoli.net \
    --to=luca@lucaceresoli.net \
    --cc=jdelvare@suse.de \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-i2c@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=peda@axentia.se \
    --cc=wsa@the-dreams.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).