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 15/28] docs: i2c: smbus-protocol: enable kernel-doc function syntax
Date: Thu, 23 Jan 2020 15:56:13 +0100	[thread overview]
Message-ID: <20200123145626.8102-2-luca@lucaceresoli.net> (raw)
In-Reply-To: <20200123145626.8102-1-luca@lucaceresoli.net>

Hyperlinks from function names are not generated in headings. Move them in
the plain text so they are rendered as clickable hyperlinks.

While there also remove an unneeded colon in a heading.

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

---

Changes in v2:
 - fix typo in commit message (Jean Delvare)
---
 Documentation/i2c/smbus-protocol.rst | 64 ++++++++++++++++++----------
 1 file changed, 42 insertions(+), 22 deletions(-)

diff --git a/Documentation/i2c/smbus-protocol.rst b/Documentation/i2c/smbus-protocol.rst
index 10c4a989982c..997945e90419 100644
--- a/Documentation/i2c/smbus-protocol.rst
+++ b/Documentation/i2c/smbus-protocol.rst
@@ -62,8 +62,10 @@ This sends a single bit to the device, at the place of the Rd/Wr bit::
 Functionality flag: I2C_FUNC_SMBUS_QUICK
 
 
-SMBus Receive Byte:  i2c_smbus_read_byte()
-==========================================
+SMBus Receive Byte
+==================
+
+Implemented by i2c_smbus_read_byte()
 
 This reads a single byte from a device, without specifying a device
 register. Some devices are so simple that this interface is enough; for
@@ -75,8 +77,10 @@ the previous SMBus command::
 Functionality flag: I2C_FUNC_SMBUS_READ_BYTE
 
 
-SMBus Send Byte:  i2c_smbus_write_byte()
-========================================
+SMBus Send Byte
+===============
+
+Implemented by i2c_smbus_write_byte()
 
 This operation is the reverse of Receive Byte: it sends a single byte
 to a device.  See Receive Byte for more information.
@@ -88,8 +92,10 @@ to a device.  See Receive Byte for more information.
 Functionality flag: I2C_FUNC_SMBUS_WRITE_BYTE
 
 
-SMBus Read Byte:  i2c_smbus_read_byte_data()
-============================================
+SMBus Read Byte
+===============
+
+Implemented by i2c_smbus_read_byte_data()
 
 This reads a single byte from a device, from a designated register.
 The register is specified through the Comm byte::
@@ -99,8 +105,10 @@ The register is specified through the Comm byte::
 Functionality flag: I2C_FUNC_SMBUS_READ_BYTE_DATA
 
 
-SMBus Read Word:  i2c_smbus_read_word_data()
-============================================
+SMBus Read Word
+===============
+
+Implemented by i2c_smbus_read_word_data()
 
 This operation is very like Read Byte; again, data is read from a
 device, from a designated register that is specified through the Comm
@@ -115,8 +123,10 @@ available for reads where the two data bytes are the other way
 around (not SMBus compliant, but very popular.)
 
 
-SMBus Write Byte:  i2c_smbus_write_byte_data()
-==============================================
+SMBus Write Byte
+================
+
+Implemented by i2c_smbus_write_byte_data()
 
 This writes a single byte to a device, to a designated register. The
 register is specified through the Comm byte. This is the opposite of
@@ -129,8 +139,10 @@ the Read Byte operation.
 Functionality flag: I2C_FUNC_SMBUS_WRITE_BYTE_DATA
 
 
-SMBus Write Word:  i2c_smbus_write_word_data()
-==============================================
+SMBus Write Word
+================
+
+Implemented by i2c_smbus_write_word_data()
 
 This is the opposite of the Read Word operation. 16 bits
 of data is written to a device, to the designated register that is
@@ -145,8 +157,8 @@ available for writes where the two data bytes are the other way
 around (not SMBus compliant, but very popular.)
 
 
-SMBus Process Call:
-===================
+SMBus Process Call
+==================
 
 This command selects a device register (through the Comm byte), sends
 16 bits of data to it, and reads 16 bits of data in return::
@@ -157,8 +169,10 @@ This command selects a device register (through the Comm byte), sends
 Functionality flag: I2C_FUNC_SMBUS_PROC_CALL
 
 
-SMBus Block Read:  i2c_smbus_read_block_data()
-==============================================
+SMBus Block Read
+================
+
+Implemented by i2c_smbus_read_block_data()
 
 This command reads a block of up to 32 bytes from a device, from a
 designated register that is specified through the Comm byte. The amount
@@ -172,8 +186,10 @@ of data is specified by the device in the Count byte.
 Functionality flag: I2C_FUNC_SMBUS_READ_BLOCK_DATA
 
 
-SMBus Block Write:  i2c_smbus_write_block_data()
-================================================
+SMBus Block Write
+=================
+
+Implemented by i2c_smbus_write_block_data()
 
 The opposite of the Block Read command, this writes up to 32 bytes to
 a device, to a designated register that is specified through the
@@ -274,8 +290,10 @@ I2C block transactions do not limit the number of bytes transferred
 but the SMBus layer places a limit of 32 bytes.
 
 
-I2C Block Read:  i2c_smbus_read_i2c_block_data()
-================================================
+I2C Block Read
+==============
+
+Implemented by i2c_smbus_read_i2c_block_data()
 
 This command reads a block of bytes from a device, from a
 designated register that is specified through the Comm byte::
@@ -286,8 +304,10 @@ designated register that is specified through the Comm byte::
 Functionality flag: I2C_FUNC_SMBUS_READ_I2C_BLOCK
 
 
-I2C Block Write:  i2c_smbus_write_i2c_block_data()
-==================================================
+I2C Block Write
+===============
+
+Implemented by i2c_smbus_write_i2c_block_data()
 
 The opposite of the Block Read command, this writes bytes to
 a device, to a designated register that is specified through the
-- 
2.25.0

  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   ` Luca Ceresoli [this message]
2020-01-23 14:56   ` [PATCH v2 16/28] docs: i2c: smbus-protocol: fix kernel-doc function syntax 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   ` [PATCH v2 22/28] docs: i2c: instantiating-devices: use monospace for sysfs attributes Luca Ceresoli
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-2-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).