From: Wolfram Sang <wsa@the-dreams.de>
To: Luca Ceresoli <luca@lucaceresoli.net>
Cc: Jean Delvare <jdelvare@suse.de>,
Linux I2C <linux-i2c@vger.kernel.org>,
Lei YU <mine260309@gmail.com>
Subject: Re: [PATCH 2/2] docs: i2c: dev-interface: document the actual implementation
Date: Mon, 3 Feb 2020 20:43:23 +0100 [thread overview]
Message-ID: <20200203194323.GA1281@kunai> (raw)
In-Reply-To: <11fd5351-e273-c700-2e6b-2066a5e77798@lucaceresoli.net>
[-- Attachment #1: Type: text/plain, Size: 729 bytes --]
> In my opinion we should first document the recommended way. Assuming
> libi2c is the recommended way for all uses it is capable of, that means
> documenting libi2c first.
>
> Additionally, before documenting any of them I'd add a preamble similar
> to: "The I2C device can be accessed from user space either using the
> libi2c library or using low-level C functions directly. libi2c is more
> high-level but has limited functionality.". This is so it's clear to the
> reader from the beginning that there are two alternative approaches,
> whose explanation will follow.
This! If we have such a paragraph, then while I still think swapping
makes a bit more sense, the order is not so important to me anymore.
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
next prev parent reply other threads:[~2020-02-03 19:43 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
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 [this message]
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=20200203194323.GA1281@kunai \
--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;
as well as URLs for NNTP newsgroup(s).