Thread (72 messages) 72 messages, 4 authors, 2020-01-23

Re: [PATCH 15/26] docs: i2c: smbus-protocol: enable kernel-doc function syntax

From: Luca Ceresoli <luca@lucaceresoli.net>
Date: 2020-01-21 17:31:27
Also in: linux-i2c, lkml

Hi Jean,

On 20/01/20 15:44, Jean Delvare wrote:
On Sun,  5 Jan 2020 23:50:01 +0100, Luca Ceresoli wrote:
quoted
Hyperlinks from function names are not generated in headings. Move them in
the plain text so they are rendered as clickable hyerlinks.
typo: hyperlinks
Ok.
quoted
While there also remove an unneeded colon in a heading.

Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
---
 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()
In file i2c-protocol.rst, the wording used is:

This corresponds to i2c_transfer().

For consistency, can we settle for "Implemented by foo()" everywhere?
Good point. For v2 I added a new patch to use "Implemented by" also in
i2c-protocol.rst.

Thanks.

By extrapolation I guess you want to review the few remaining patches.
Correnct? In this case I'd wait for that before sending out v2.

-- 
Luca
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help