public inbox for linux-i2c@vger.kernel.org
 help / color / mirror / Atom feed
From: Wolfram Sang <wsa@the-dreams.de>
To: Jean Delvare <jdelvare@suse.de>
Cc: Linux I2C <linux-i2c@vger.kernel.org>,
	Lei YU <mine260309@gmail.com>,
	Luca Ceresoli <luca@lucaceresoli.net>
Subject: Re: [PATCH 2/2] docs: i2c: dev-interface: document the actual implementation
Date: Thu, 23 Jan 2020 12:09:09 +0100	[thread overview]
Message-ID: <20200123110909.GG1105@ninjato> (raw)
In-Reply-To: <20200123111137.5899fa5a@endymion>

[-- Attachment #1: Type: text/plain, Size: 791 bytes --]

On Thu, Jan 23, 2020 at 11:11:37AM +0100, Jean Delvare wrote:
> The old i2c-dev API based on inline functions is long gone, we have
> libi2c now which implements the same as real functions and comes with
> complete API documentation. Update the dev-interface documentation
> file accordingly to only mention what can be done without the
> library, and redirect the reader to the libi2c manual page for the
> rest.
> 
> Signed-off-by: Jean Delvare <jdelvare@suse.de>
> Reported-by: Lei YU <mine260309@gmail.com>
> Cc: Wolfram Sang <wsa@the-dreams.de>
> Cc: Luca Ceresoli <luca@lucaceresoli.net>

I wonder if we shouldn't move the 'C library'  paragraph before the 'C
example'? To make sure people are aware of it (and use it) early before
digging into the low-level C code?


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

  reply	other threads:[~2020-01-23 11:09 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-01-23  9:52 [PATCH 0/2] Move the SMBus API documentation to libi2c Jean Delvare
2020-01-23 10:03 ` [PATCH 1/2] libi2c: Add a manual page to document the API Jean Delvare
2020-01-23 10:17   ` Jean Delvare
2020-01-23 10:11 ` [PATCH 2/2] docs: i2c: dev-interface: document the actual implementation Jean Delvare
2020-01-23 11:09   ` Wolfram Sang [this message]
2020-01-23 13:42     ` Luca Ceresoli
2020-02-03 13:27       ` Jean Delvare
2020-02-03 16:35         ` Luca Ceresoli
2020-02-03 19:43           ` Wolfram Sang
2020-02-04 17:17           ` Jean Delvare
2020-01-29 21:13   ` Wolfram Sang
2020-02-03 12:21     ` 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=20200123110909.GG1105@ninjato \
    --to=wsa@the-dreams.de \
    --cc=jdelvare@suse.de \
    --cc=linux-i2c@vger.kernel.org \
    --cc=luca@lucaceresoli.net \
    --cc=mine260309@gmail.com \
    /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