kconfig: fix documentation typos
diff mbox series

Message ID 20200113232212.138327-1-helgaas@kernel.org
State New
Headers show
Series
  • kconfig: fix documentation typos
Related show

Commit Message

Bjorn Helgaas Jan. 13, 2020, 11:22 p.m. UTC
From: Bjorn Helgaas <bhelgaas@google.com>

Fix a couple typos in kconfig-language documentation.

Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
---
 Documentation/kbuild/kconfig-language.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Jonathan Corbet Jan. 16, 2020, 7:52 p.m. UTC | #1
On Mon, 13 Jan 2020 17:22:11 -0600
Bjorn Helgaas <helgaas@kernel.org> wrote:

> From: Bjorn Helgaas <bhelgaas@google.com>
> 
> Fix a couple typos in kconfig-language documentation.
> 
> Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
> ---
>  Documentation/kbuild/kconfig-language.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)

Looks good to me; Masahiro I assume you'll be taking this one?

Thanks,

jon
Masahiro Yamada Jan. 17, 2020, 2:17 a.m. UTC | #2
On Tue, Jan 14, 2020 at 8:22 AM Bjorn Helgaas <helgaas@kernel.org> wrote:
>
> From: Bjorn Helgaas <bhelgaas@google.com>
>
> Fix a couple typos in kconfig-language documentation.
>
> Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
> ---
>  Documentation/kbuild/kconfig-language.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/kbuild/kconfig-language.rst b/Documentation/kbuild/kconfig-language.rst
> index 74bef19f69f0..f547720bd82d 100644
> --- a/Documentation/kbuild/kconfig-language.rst
> +++ b/Documentation/kbuild/kconfig-language.rst
> @@ -594,7 +594,7 @@ The two different resolutions for b) can be tested in the sample Kconfig file
>  Documentation/kbuild/Kconfig.recursion-issue-02.
>
>  Below is a list of examples of prior fixes for these types of recursive issues;
> -all errors appear to involve one or more select's and one or more "depends on".
> +all errors appear to involve one or more "selects" and one or more "depends on".


I think "selects" is strange here.

"select" is a Kconfig keyword.
select's is intentional, I guess.


Keep it as-is, or perhaps change it into "select" (singular) ?






>
>  ============    ===================================
>  commit          fix
> @@ -656,7 +656,7 @@ the use of the xconfig configurator [1]_. Work should be done to confirm if
>  the deduced semantics matches our intended Kconfig design goals.
>
>  Having well defined semantics can be useful for tools for practical
> -evaluation of depenencies, for instance one such use known case was work to
> +evaluation of dependencies, for instance one such case was work to
>  express in boolean abstraction of the inferred semantics of Kconfig to
>  translate Kconfig logic into boolean formulas and run a SAT solver on this to
>  find dead code / features (always inactive), 114 dead features were found in
> @@ -683,7 +683,7 @@ abstraction the inferred semantics of Kconfig to translate Kconfig logic into
>  boolean formulas and run a SAT solver on it [5]_. Another known related project
>  is CADOS [6]_ (former VAMOS [7]_) and the tools, mainly undertaker [8]_, which
>  has been introduced first with [9]_.  The basic concept of undertaker is to
> -exract variability models from Kconfig, and put them together with a
> +extract variability models from Kconfig and put them together with a
>  propositional formula extracted from CPP #ifdefs and build-rules into a SAT
>  solver in order to find dead code, dead files, and dead symbols. If using a SAT
>  solver is desirable on Kconfig one approach would be to evaluate repurposing
> --
> 2.25.0.rc1.283.g88dfdc4193-goog
>
Masahiro Yamada Jan. 17, 2020, 2:27 a.m. UTC | #3
On Fri, Jan 17, 2020 at 4:52 AM Jonathan Corbet <corbet@lwn.net> wrote:
>
> On Mon, 13 Jan 2020 17:22:11 -0600
> Bjorn Helgaas <helgaas@kernel.org> wrote:
>
> > From: Bjorn Helgaas <bhelgaas@google.com>
> >
> > Fix a couple typos in kconfig-language documentation.
> >
> > Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
> > ---
> >  Documentation/kbuild/kconfig-language.rst | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
>
> Looks good to me; Masahiro I assume you'll be taking this one?
>
> Thanks,
>
> jon


I can pick this up, but I commented on the first paragraph.

(I do not know what is the best way to describe the
plural form of a special keyword...)







--
Best Regards
Masahiro Yamada
Randy Dunlap Jan. 17, 2020, 3:54 a.m. UTC | #4
On 1/16/20 6:17 PM, Masahiro Yamada wrote:
> On Tue, Jan 14, 2020 at 8:22 AM Bjorn Helgaas <helgaas@kernel.org> wrote:
>>
>> From: Bjorn Helgaas <bhelgaas@google.com>
>>
>> Fix a couple typos in kconfig-language documentation.
>>
>> Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
>> ---
>>  Documentation/kbuild/kconfig-language.rst | 6 +++---
>>  1 file changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/Documentation/kbuild/kconfig-language.rst b/Documentation/kbuild/kconfig-language.rst
>> index 74bef19f69f0..f547720bd82d 100644
>> --- a/Documentation/kbuild/kconfig-language.rst
>> +++ b/Documentation/kbuild/kconfig-language.rst
>> @@ -594,7 +594,7 @@ The two different resolutions for b) can be tested in the sample Kconfig file
>>  Documentation/kbuild/Kconfig.recursion-issue-02.
>>
>>  Below is a list of examples of prior fixes for these types of recursive issues;
>> -all errors appear to involve one or more select's and one or more "depends on".
>> +all errors appear to involve one or more "selects" and one or more "depends on".
> 
> 
> I think "selects" is strange here.

I thought so when I read it also.

> 
> "select" is a Kconfig keyword.
> select's is intentional, I guess.

Yes, I expect so.

> Keep it as-is, or perhaps change it into "select" (singular) ?

Maybe:

 Below is a list of examples of prior fixes for these types of recursive issues;
-all errors appear to involve one or more select's and one or more "depends on".
+all errors appear to involve one or more "select"s and one or more "depends on".
Bjorn Helgaas Jan. 17, 2020, 4:07 a.m. UTC | #5
On Thu, Jan 16, 2020 at 8:18 PM Masahiro Yamada <masahiroy@kernel.org> wrote:
>
> On Tue, Jan 14, 2020 at 8:22 AM Bjorn Helgaas <helgaas@kernel.org> wrote:
> >
> > From: Bjorn Helgaas <bhelgaas@google.com>
> >
> > Fix a couple typos in kconfig-language documentation.
> >
> > Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
> > ---
> >  Documentation/kbuild/kconfig-language.rst | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> >
> > diff --git a/Documentation/kbuild/kconfig-language.rst b/Documentation/kbuild/kconfig-language.rst
> > index 74bef19f69f0..f547720bd82d 100644
> > --- a/Documentation/kbuild/kconfig-language.rst
> > +++ b/Documentation/kbuild/kconfig-language.rst
> > @@ -594,7 +594,7 @@ The two different resolutions for b) can be tested in the sample Kconfig file
> >  Documentation/kbuild/Kconfig.recursion-issue-02.
> >
> >  Below is a list of examples of prior fixes for these types of recursive issues;
> > -all errors appear to involve one or more select's and one or more "depends on".
> > +all errors appear to involve one or more "selects" and one or more "depends on".
>
>
> I think "selects" is strange here.
>
> "select" is a Kconfig keyword.
> select's is intentional, I guess.
>
>
> Keep it as-is, or perhaps change it into "select" (singular) ?

With rare exceptions, apostrophes are not used to form a plural noun.

Maybe it could be recast as "... at least one 'select' attribute and
at least one 'depends on' attribute"?

I'm not quite sure what the intended meaning is, because the table it
refers to has lines that contain only "depends on" (without "select")
and also lines that contain only "select" (no "depends on").


> >  ============    ===================================
> >  commit          fix
> > @@ -656,7 +656,7 @@ the use of the xconfig configurator [1]_. Work should be done to confirm if
> >  the deduced semantics matches our intended Kconfig design goals.
> >
> >  Having well defined semantics can be useful for tools for practical
> > -evaluation of depenencies, for instance one such use known case was work to
> > +evaluation of dependencies, for instance one such case was work to
> >  express in boolean abstraction of the inferred semantics of Kconfig to
> >  translate Kconfig logic into boolean formulas and run a SAT solver on this to
> >  find dead code / features (always inactive), 114 dead features were found in
> > @@ -683,7 +683,7 @@ abstraction the inferred semantics of Kconfig to translate Kconfig logic into
> >  boolean formulas and run a SAT solver on it [5]_. Another known related project
> >  is CADOS [6]_ (former VAMOS [7]_) and the tools, mainly undertaker [8]_, which
> >  has been introduced first with [9]_.  The basic concept of undertaker is to
> > -exract variability models from Kconfig, and put them together with a
> > +extract variability models from Kconfig and put them together with a
> >  propositional formula extracted from CPP #ifdefs and build-rules into a SAT
> >  solver in order to find dead code, dead files, and dead symbols. If using a SAT
> >  solver is desirable on Kconfig one approach would be to evaluate repurposing
> > --
> > 2.25.0.rc1.283.g88dfdc4193-goog
> >
>
>
> --
> Best Regards
> Masahiro Yamada
Jonathan Corbet Jan. 17, 2020, 2:50 p.m. UTC | #6
On Fri, 17 Jan 2020 11:17:15 +0900
Masahiro Yamada <masahiroy@kernel.org> wrote:

> > -all errors appear to involve one or more select's and one or more "depends on".
> > +all errors appear to involve one or more "selects" and one or more "depends on".  
> 
> 
> I think "selects" is strange here.
> 
> "select" is a Kconfig keyword.
> select's is intentional, I guess.
> 
> Keep it as-is, or perhaps change it into "select" (singular) ?

Apostrophe abuse is one of those ways to annoy a certain percentage of
your reader's :)

It could be as Bjorn made it, or:

	"select" statements
	``select``s

jon

Patch
diff mbox series

diff --git a/Documentation/kbuild/kconfig-language.rst b/Documentation/kbuild/kconfig-language.rst
index 74bef19f69f0..f547720bd82d 100644
--- a/Documentation/kbuild/kconfig-language.rst
+++ b/Documentation/kbuild/kconfig-language.rst
@@ -594,7 +594,7 @@  The two different resolutions for b) can be tested in the sample Kconfig file
 Documentation/kbuild/Kconfig.recursion-issue-02.
 
 Below is a list of examples of prior fixes for these types of recursive issues;
-all errors appear to involve one or more select's and one or more "depends on".
+all errors appear to involve one or more "selects" and one or more "depends on".
 
 ============    ===================================
 commit          fix
@@ -656,7 +656,7 @@  the use of the xconfig configurator [1]_. Work should be done to confirm if
 the deduced semantics matches our intended Kconfig design goals.
 
 Having well defined semantics can be useful for tools for practical
-evaluation of depenencies, for instance one such use known case was work to
+evaluation of dependencies, for instance one such case was work to
 express in boolean abstraction of the inferred semantics of Kconfig to
 translate Kconfig logic into boolean formulas and run a SAT solver on this to
 find dead code / features (always inactive), 114 dead features were found in
@@ -683,7 +683,7 @@  abstraction the inferred semantics of Kconfig to translate Kconfig logic into
 boolean formulas and run a SAT solver on it [5]_. Another known related project
 is CADOS [6]_ (former VAMOS [7]_) and the tools, mainly undertaker [8]_, which
 has been introduced first with [9]_.  The basic concept of undertaker is to
-exract variability models from Kconfig, and put them together with a
+extract variability models from Kconfig and put them together with a
 propositional formula extracted from CPP #ifdefs and build-rules into a SAT
 solver in order to find dead code, dead files, and dead symbols. If using a SAT
 solver is desirable on Kconfig one approach would be to evaluate repurposing