| Message ID | 20241120-pwrseq-doc-trivial-fixes-v1-1-19a70f4dd156@gmail.com (mailing list archive) |
|---|---|
| State | Handled Elsewhere, archived |
| Headers | show |
| Series | Documentation: pwrseq: Fix trivial misspellings | expand |
On 11/19/24 5:14 PM, Javier Carrasco wrote: > Use proper spelling for 'discrete'. When at it, capitalize 'Linux', > which is common practice in the documentation. > > Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com> LGTM. Thanks. Reviewed-by: Randy Dunlap <rdunlap@infradead.org> > --- > Documentation/driver-api/pwrseq.rst | 8 ++++---- > 1 file changed, 4 insertions(+), 4 deletions(-) > > diff --git a/Documentation/driver-api/pwrseq.rst b/Documentation/driver-api/pwrseq.rst > index a644084ded17..ad18b2326b68 100644 > --- a/Documentation/driver-api/pwrseq.rst > +++ b/Documentation/driver-api/pwrseq.rst > @@ -11,7 +11,7 @@ Introduction > ============ > > This framework is designed to abstract complex power-up sequences that are > -shared between multiple logical devices in the linux kernel. > +shared between multiple logical devices in the Linux kernel. > > The intention is to allow consumers to obtain a power sequencing handle > exposed by the power sequence provider and delegate the actual requesting and > @@ -25,7 +25,7 @@ The power sequencing API uses a number of terms specific to the subsystem: > > Unit > > - A unit is a discreet chunk of a power sequence. For instance one unit may > + A unit is a discrete chunk of a power sequence. For instance one unit may > enable a set of regulators, another may enable a specific GPIO. Units can > define dependencies in the form of other units that must be enabled before > it itself can be. > @@ -62,7 +62,7 @@ Provider interface > The provider API is admittedly not nearly as straightforward as the one for > consumers but it makes up for it in flexibility. > > -Each provider can logically split the power-up sequence into descrete chunks > +Each provider can logically split the power-up sequence into discrete chunks > (units) and define their dependencies. They can then expose named targets that > consumers may use as the final point in the sequence that they wish to reach. > > @@ -72,7 +72,7 @@ register with the pwrseq subsystem by calling pwrseq_device_register(). > Dynamic consumer matching > ------------------------- > > -The main difference between pwrseq and other linux kernel providers is the > +The main difference between pwrseq and other Linux kernel providers is the > mechanism for dynamic matching of consumers and providers. Every power sequence > provider driver must implement the `match()` callback and pass it to the pwrseq > core when registering with the subsystems. > > --- > base-commit: 414c97c966b69e4a6ea7b32970fa166b2f9b9ef0 > change-id: 20241120-pwrseq-doc-trivial-fixes-ee8744695d52 > > Best regards,
Javier Carrasco <javier.carrasco.cruz@gmail.com> writes: > Use proper spelling for 'discrete'. When at it, capitalize 'Linux', > which is common practice in the documentation. > > Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com> > --- > Documentation/driver-api/pwrseq.rst | 8 ++++---- > 1 file changed, 4 insertions(+), 4 deletions(-) Applied, thanks. jon
diff --git a/Documentation/driver-api/pwrseq.rst b/Documentation/driver-api/pwrseq.rst index a644084ded17..ad18b2326b68 100644 --- a/Documentation/driver-api/pwrseq.rst +++ b/Documentation/driver-api/pwrseq.rst @@ -11,7 +11,7 @@ Introduction ============ This framework is designed to abstract complex power-up sequences that are -shared between multiple logical devices in the linux kernel. +shared between multiple logical devices in the Linux kernel. The intention is to allow consumers to obtain a power sequencing handle exposed by the power sequence provider and delegate the actual requesting and @@ -25,7 +25,7 @@ The power sequencing API uses a number of terms specific to the subsystem: Unit - A unit is a discreet chunk of a power sequence. For instance one unit may + A unit is a discrete chunk of a power sequence. For instance one unit may enable a set of regulators, another may enable a specific GPIO. Units can define dependencies in the form of other units that must be enabled before it itself can be. @@ -62,7 +62,7 @@ Provider interface The provider API is admittedly not nearly as straightforward as the one for consumers but it makes up for it in flexibility. -Each provider can logically split the power-up sequence into descrete chunks +Each provider can logically split the power-up sequence into discrete chunks (units) and define their dependencies. They can then expose named targets that consumers may use as the final point in the sequence that they wish to reach. @@ -72,7 +72,7 @@ register with the pwrseq subsystem by calling pwrseq_device_register(). Dynamic consumer matching ------------------------- -The main difference between pwrseq and other linux kernel providers is the +The main difference between pwrseq and other Linux kernel providers is the mechanism for dynamic matching of consumers and providers. Every power sequence provider driver must implement the `match()` callback and pass it to the pwrseq core when registering with the subsystems.
Use proper spelling for 'discrete'. When at it, capitalize 'Linux', which is common practice in the documentation. Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com> --- Documentation/driver-api/pwrseq.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) --- base-commit: 414c97c966b69e4a6ea7b32970fa166b2f9b9ef0 change-id: 20241120-pwrseq-doc-trivial-fixes-ee8744695d52 Best regards,