linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Luca Ceresoli <luca.ceresoli@bootlin.com>
To: Bagas Sanjaya <bagasdotme@gmail.com>
Cc: linux-doc@vger.kernel.org, linux-i2c@vger.kernel.org,
	Wolfram Sang <wsa@kernel.org>, Peter Rosin <peda@axentia.se>,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH 7/9] docs: i2c: i2c-topology: reorder sections more logically
Date: Tue, 9 Aug 2022 09:06:42 +0200	[thread overview]
Message-ID: <20220809090642.7bd2624e@booty> (raw)
In-Reply-To: <3971c298-9c9a-83a1-8dc7-5d59dd0e1a05@gmail.com>

Hello Bagas,

thanks for the prompt review!

On Tue, 9 Aug 2022 09:08:03 +0700
Bagas Sanjaya <bagasdotme@gmail.com> wrote:

> On 8/8/22 21:17, luca.ceresoli@bootlin.com wrote:
> > +Mux-locked caveats
> > +~~~~~~~~~~~~~~~~~~
> > +
> > +When using a mux-locked mux, be aware of the following restrictions:
> > +
> > +* If you build a topology with a mux-locked mux being the parent
> > +  of a parent-locked mux, this might break the expectation from the
> > +  parent-locked mux that the root adapter is locked during the
> > +  transaction.
> > +
> > +* It is not safe to build arbitrary topologies with two (or more)
> > +  mux-locked muxes that are not siblings, when there are address
> > +  collisions between the devices on the child adapters of these
> > +  non-sibling muxes.
> > +
> > +  I.e. the select-transfer-deselect transaction targeting e.g. device
> > +  address 0x42 behind mux-one may be interleaved with a similar
> > +  operation targeting device address 0x42 behind mux-two. The
> > +  intension with such a topology would in this hypothetical example
> > +  be that mux-one and mux-two should not be selected simultaneously,
> > +  but mux-locked muxes do not guarantee that in all topologies.
> > +  
> 
> These two sentences in n. 2) can be combined into a single paragraph.
> Also, did you mean s/intension/intention/?

This patch does nothing but reformatting the current text.

Definitely "intension" is a mistake that I didn't spot, I'm adding a
patch to fix that.

About the paragraph split, I have no strong opinion but I'm feeling OK
with the current layout. It splits the generic statement from the
example and IMHO helps readability. Feel free to send a patch to change
that though, if you think it is useful.

-- 
Luca Ceresoli, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

  reply	other threads:[~2022-08-09  7:06 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-08-08 14:16 [PATCH 0/9] docs: i2c: rework I2C documentation, part II luca.ceresoli
2022-08-08 14:17 ` [PATCH 1/9] docs: i2c: i2c-protocol: update introductory paragraph luca.ceresoli
2022-08-11 21:03   ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 2/9] docs: i2c: i2c-protocol,smbus-protocol: remove nonsense words luca.ceresoli
2022-08-11 21:03   ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 3/9] docs: i2c: i2c-protocol: remove unused legend items luca.ceresoli
2022-08-11 21:05   ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 4/9] docs: i2c: smbus-protocol: improve DataLow/DataHigh definition luca.ceresoli
2022-08-09  1:55   ` Bagas Sanjaya
2022-08-11 21:05   ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 5/9] docs: i2c: instantiating-devices: add syntax coloring to dts and C blocks luca.ceresoli
2022-08-11 21:07   ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 6/9] docs: i2c: i2c-topology: fix incorrect heading luca.ceresoli
2022-08-11 21:09   ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 7/9] docs: i2c: i2c-topology: reorder sections more logically luca.ceresoli
2022-08-09  2:08   ` Bagas Sanjaya
2022-08-09  7:06     ` Luca Ceresoli [this message]
2022-08-11 21:09   ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 8/9] docs: i2c: i2c-sysfs: improve wording luca.ceresoli
2022-08-11 21:13   ` Wolfram Sang
2022-08-11 21:23     ` Wolfram Sang
2022-08-12  7:13       ` Luca Ceresoli
2022-08-08 14:17 ` [PATCH 9/9] docs: i2c: i2c-sysfs: fix hyperlinks luca.ceresoli
2022-08-11 21:21   ` Wolfram Sang

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=20220809090642.7bd2624e@booty \
    --to=luca.ceresoli@bootlin.com \
    --cc=bagasdotme@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-i2c@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=peda@axentia.se \
    --cc=wsa@kernel.org \
    /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).