From: Luca Ceresoli <luca@lucaceresoli.net>
To: linux-doc@vger.kernel.org, linux-i2c@vger.kernel.org
Cc: Luca Ceresoli <luca@lucaceresoli.net>,
Wolfram Sang <wsa@the-dreams.de>, Peter Rosin <peda@axentia.se>,
linux-kernel@vger.kernel.org
Subject: [PATCH 16/26] docs: i2c: smbus-protocol: fix kernel-doc function syntax
Date: Sun, 5 Jan 2020 23:50:02 +0100 [thread overview]
Message-ID: <20200105225012.11701-16-luca@lucaceresoli.net> (raw)
In-Reply-To: <20200105225012.11701-1-luca@lucaceresoli.net>
This clarifies these are functions (and would/will adds a hyperlink to the
function documentation if/when documented).
Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
---
Documentation/i2c/smbus-protocol.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/i2c/smbus-protocol.rst b/Documentation/i2c/smbus-protocol.rst
index 997945e90419..3c0fb3a2044d 100644
--- a/Documentation/i2c/smbus-protocol.rst
+++ b/Documentation/i2c/smbus-protocol.rst
@@ -118,7 +118,7 @@ byte. But this time, the data is a complete word (16 bits)::
Functionality flag: I2C_FUNC_SMBUS_READ_WORD_DATA
-Note the convenience function i2c_smbus_read_word_swapped is
+Note the convenience function i2c_smbus_read_word_swapped() is
available for reads where the two data bytes are the other way
around (not SMBus compliant, but very popular.)
@@ -152,7 +152,7 @@ specified through the Comm byte.::
Functionality flag: I2C_FUNC_SMBUS_WRITE_WORD_DATA
-Note the convenience function i2c_smbus_write_word_swapped is
+Note the convenience function i2c_smbus_write_word_swapped() is
available for writes where the two data bytes are the other way
around (not SMBus compliant, but very popular.)
--
2.24.1
next prev parent reply other threads:[~2020-01-05 22:51 UTC|newest]
Thread overview: 72+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-05 22:39 [PATCH 00/26] docs: i2c: rework I2C documentation, part I Luca Ceresoli
2020-01-05 22:49 ` [PATCH 01/26] docs: i2c: sort index logically Luca Ceresoli
2020-01-05 22:49 ` [PATCH 02/26] docs: i2c: summary: extend introduction Luca Ceresoli
2020-01-20 9:27 ` Jean Delvare
2020-01-20 21:54 ` Luca Ceresoli
2020-01-05 22:49 ` [PATCH 03/26] docs: i2c: summary: rewrite the "terminology" section Luca Ceresoli
2020-01-20 10:04 ` Jean Delvare
2020-01-05 22:49 ` [PATCH 04/26] docs: i2c: call it "I2C" consistently Luca Ceresoli
2020-01-07 10:33 ` Peter Rosin
2020-01-16 9:39 ` Jean Delvare
2020-01-05 22:49 ` [PATCH 05/26] docs: i2c: fix typo Luca Ceresoli
2020-01-07 10:33 ` Peter Rosin
2020-01-16 9:40 ` Jean Delvare
2020-01-05 22:49 ` [PATCH 06/26] docs: i2c: replace "I2C-transfer" -> "I2C transfer" consistently Luca Ceresoli
2020-01-07 10:34 ` Peter Rosin
2020-01-20 10:07 ` Jean Delvare
2020-01-05 22:49 ` [PATCH 07/26] docs: i2c: i2c-protocol: fix kernel-doc function syntax Luca Ceresoli
2020-01-20 10:51 ` Jean Delvare
2020-01-05 22:49 ` [PATCH 08/26] docs: i2c: i2c-protocol: properly name start and stop conditions Luca Ceresoli
2020-01-20 12:49 ` Jean Delvare
2020-01-05 22:49 ` [PATCH 09/26] docs: i2c: i2c-protocol: remove unneeded colons from table Luca Ceresoli
2020-01-20 13:38 ` Jean Delvare
2020-01-20 14:22 ` Jean Delvare
2020-01-05 22:49 ` [PATCH 10/26] docs: i2c: i2c-protocol: use proper names for ACK and NACK Luca Ceresoli
2020-01-20 13:50 ` Jean Delvare
2020-01-05 22:49 ` [PATCH 11/26] docs: i2c: smbus: fix link syntax Luca Ceresoli
2020-01-20 14:10 ` Jean Delvare
2020-01-05 22:49 ` [PATCH 12/26] docs: i2c: smbus-protocol: properly name start and stop conditions Luca Ceresoli
2020-01-20 14:16 ` Jean Delvare
2020-01-05 22:49 ` [PATCH 13/26] docs: i2c: smbus-protocol: remove unneeded colons from table Luca Ceresoli
2020-01-20 14:23 ` Jean Delvare
2020-01-05 22:50 ` [PATCH 14/26] docs: i2c: smbus-protocol: use proper names for ACK and NACK Luca Ceresoli
2020-01-20 14:26 ` Jean Delvare
2020-01-05 22:50 ` [PATCH 15/26] docs: i2c: smbus-protocol: enable kernel-doc function syntax Luca Ceresoli
2020-01-20 14:44 ` Jean Delvare
2020-01-21 17:31 ` Luca Ceresoli
2020-01-22 11:48 ` Jean Delvare
2020-01-23 9:51 ` Luca Ceresoli
2020-01-22 14:26 ` Jean Delvare
2020-01-22 15:37 ` Wolfram Sang
2020-01-23 9:51 ` Luca Ceresoli
2020-01-05 22:50 ` Luca Ceresoli [this message]
2020-01-20 14:51 ` [PATCH 16/26] docs: i2c: smbus-protocol: fix " Jean Delvare
2020-01-05 22:50 ` [PATCH 17/26] docs: i2c: i2c-protocol: fix typo Luca Ceresoli
2020-01-20 15:15 ` Jean Delvare
2020-01-05 22:50 ` [PATCH 18/26] docs: i2c: i2c-protocol: fix punctuation Luca Ceresoli
2020-01-20 15:16 ` Jean Delvare
2020-01-05 22:50 ` [PATCH 19/26] docs: i2c: smbus-protocol: improve I2C Block transactions description Luca Ceresoli
2020-01-21 9:16 ` Jean Delvare
2020-01-05 22:50 ` [PATCH 20/26] docs: i2c: instantiating-devices: fix internal hyperlink Luca Ceresoli
2020-01-21 10:07 ` Jean Delvare
2020-01-05 22:50 ` [PATCH 21/26] docs: i2c: instantiating-devices: rearrange static instatiation Luca Ceresoli
2020-01-21 18:02 ` Jean Delvare
2020-01-23 9:51 ` Luca Ceresoli
2020-01-05 22:50 ` [PATCH 22/26] docs: i2c: instantiating-devices: use monospace for filenames Luca Ceresoli
2020-01-22 10:08 ` Jean Delvare
2020-01-05 22:50 ` [PATCH 23/26] docs: i2c: old-module-parameters: fix internal hyperlink Luca Ceresoli
2020-01-22 10:16 ` Jean Delvare
2020-01-23 9:50 ` Luca Ceresoli
2020-01-20 9:08 ` [PATCH 01/26] docs: i2c: sort index logically Jean Delvare
2020-01-20 9:22 ` Luca Ceresoli
2020-01-20 13:56 ` Luca Ceresoli
2020-01-06 7:46 ` [PATCH 24/26] docs: i2c: old-module-parameters: clarify this is for obsolete kernels Luca Ceresoli
2020-01-22 11:18 ` Jean Delvare
2020-01-06 7:46 ` [PATCH 25/26] docs: i2c: old-module-parameters: use monospace for filenames Luca Ceresoli
2020-01-22 11:45 ` Jean Delvare
2020-01-06 7:49 ` [PATCH 26/26] docs: i2c: rename sections so the overall picture is clearer Luca Ceresoli
2020-01-07 10:36 ` Peter Rosin
2020-01-16 9:49 ` Jean Delvare
2020-01-16 10:38 ` Luca Ceresoli
2020-01-16 13:34 ` Peter Rosin
2020-01-06 8:03 ` [PATCH 00/26] docs: i2c: rework I2C documentation, part I Luca Ceresoli
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=20200105225012.11701-16-luca@lucaceresoli.net \
--to=luca@lucaceresoli.net \
--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).