* [PATCH 0/3] docs: gpio: mockup: Fix parameter name and missing entry
@ 2021-03-29 11:16 Alexander Dahl
2021-03-29 11:16 ` [PATCH 1/3] docs: gpio: mockup: Fix parameter name Alexander Dahl
` (2 more replies)
0 siblings, 3 replies; 10+ messages in thread
From: Alexander Dahl @ 2021-03-29 11:16 UTC (permalink / raw)
To: linux-doc, linux-gpio
Cc: linux-kernel, Linus Walleij, Bartosz Golaszewski,
Jonathan Corbet, Alexander Dahl
Hei hei,
while experimenting with the gpio-mockup driver, I found minor flaws in
the documentation, addressed in the three patches of this series.
Greets
Alex
Alexander Dahl (3):
docs: gpio: mockup: Fix parameter name
docs: kernel-parameters: Move gpio-mockup for alphabetic order
docs: kernel-parameters: Add gpio_mockup_named_lines
Documentation/admin-guide/gpio/gpio-mockup.rst | 2 +-
Documentation/admin-guide/kernel-parameters.txt | 10 ++++++----
2 files changed, 7 insertions(+), 5 deletions(-)
base-commit: a5e13c6df0e41702d2b2c77c8ad41677ebb065b3
--
2.20.1
^ permalink raw reply [flat|nested] 10+ messages in thread
* [PATCH 1/3] docs: gpio: mockup: Fix parameter name
2021-03-29 11:16 [PATCH 0/3] docs: gpio: mockup: Fix parameter name and missing entry Alexander Dahl
@ 2021-03-29 11:16 ` Alexander Dahl
2021-03-31 7:44 ` Bartosz Golaszewski
2021-03-31 12:27 ` Andy Shevchenko
2021-03-29 11:16 ` [PATCH 2/3] docs: kernel-parameters: Move gpio-mockup for alphabetic order Alexander Dahl
2021-03-29 11:16 ` [PATCH 3/3] docs: kernel-parameters: Add gpio_mockup_named_lines Alexander Dahl
2 siblings, 2 replies; 10+ messages in thread
From: Alexander Dahl @ 2021-03-29 11:16 UTC (permalink / raw)
To: linux-doc, linux-gpio
Cc: linux-kernel, Linus Walleij, Bartosz Golaszewski,
Jonathan Corbet, Alexander Dahl
Module probing with the parameter documented yielded this in kernel log:
gpio_mockup: unknown parameter 'gpio_named_lines' ignored
The parameter documented did not match the parameter actually
implemented with commit 8a68ea00a62e ("gpio: mockup: implement naming
the lines") long before introducing the documentation.
Fixes: commit 2fd1abe99e5f ("Documentation: gpio: add documentation for gpio-mockup")
Signed-off-by: Alexander Dahl <ada@thorsis.com>
---
Documentation/admin-guide/gpio/gpio-mockup.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/admin-guide/gpio/gpio-mockup.rst b/Documentation/admin-guide/gpio/gpio-mockup.rst
index 9fa1618b3adc..e3cafb4451aa 100644
--- a/Documentation/admin-guide/gpio/gpio-mockup.rst
+++ b/Documentation/admin-guide/gpio/gpio-mockup.rst
@@ -27,7 +27,7 @@ module.
the second 16 and the third 4. The base GPIO for the third chip is set
to 405 while for two first chips it will be assigned automatically.
- gpio_named_lines
+ gpio_mockup_named_lines
This parameter doesn't take any arguments. It lets the driver know that
GPIO lines exposed by it should be named.
--
2.20.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH 2/3] docs: kernel-parameters: Move gpio-mockup for alphabetic order
2021-03-29 11:16 [PATCH 0/3] docs: gpio: mockup: Fix parameter name and missing entry Alexander Dahl
2021-03-29 11:16 ` [PATCH 1/3] docs: gpio: mockup: Fix parameter name Alexander Dahl
@ 2021-03-29 11:16 ` Alexander Dahl
2021-03-31 7:46 ` Bartosz Golaszewski
2021-03-29 11:16 ` [PATCH 3/3] docs: kernel-parameters: Add gpio_mockup_named_lines Alexander Dahl
2 siblings, 1 reply; 10+ messages in thread
From: Alexander Dahl @ 2021-03-29 11:16 UTC (permalink / raw)
To: linux-doc, linux-gpio
Cc: linux-kernel, Linus Walleij, Bartosz Golaszewski,
Jonathan Corbet, Alexander Dahl
Fixes: commit 0f98dd1b27d2 ("gpio/mockup: add virtual gpio device")
Signed-off-by: Alexander Dahl <ada@thorsis.com>
---
Documentation/admin-guide/kernel-parameters.txt | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index 04545725f187..782dc6d9b7fb 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -1461,6 +1461,10 @@
Don't use this when you are not running on the
android emulator
+ gpio-mockup.gpio_mockup_ranges
+ [HW] Sets the ranges of gpiochip of for this device.
+ Format: <start1>,<end1>,<start2>,<end2>...
+
gpt [EFI] Forces disk with valid GPT signature but
invalid Protective MBR to be treated as GPT. If the
primary GPT is corrupted, it enables the backup/alternate
@@ -1484,10 +1488,6 @@
Format: <unsigned int> such that (rxsize & ~0x1fffc0) == 0.
Default: 1024
- gpio-mockup.gpio_mockup_ranges
- [HW] Sets the ranges of gpiochip of for this device.
- Format: <start1>,<end1>,<start2>,<end2>...
-
hardlockup_all_cpu_backtrace=
[KNL] Should the hard-lockup detector generate
backtraces on all cpus.
--
2.20.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH 3/3] docs: kernel-parameters: Add gpio_mockup_named_lines
2021-03-29 11:16 [PATCH 0/3] docs: gpio: mockup: Fix parameter name and missing entry Alexander Dahl
2021-03-29 11:16 ` [PATCH 1/3] docs: gpio: mockup: Fix parameter name Alexander Dahl
2021-03-29 11:16 ` [PATCH 2/3] docs: kernel-parameters: Move gpio-mockup for alphabetic order Alexander Dahl
@ 2021-03-29 11:16 ` Alexander Dahl
2021-03-31 7:46 ` Bartosz Golaszewski
2 siblings, 1 reply; 10+ messages in thread
From: Alexander Dahl @ 2021-03-29 11:16 UTC (permalink / raw)
To: linux-doc, linux-gpio
Cc: linux-kernel, Linus Walleij, Bartosz Golaszewski,
Jonathan Corbet, Alexander Dahl
Missing since introduced in the driver.
Fixes: commit 8a68ea00a62e ("gpio: mockup: implement naming the lines")
Signed-off-by: Alexander Dahl <ada@thorsis.com>
---
Documentation/admin-guide/kernel-parameters.txt | 2 ++
1 file changed, 2 insertions(+)
diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index 782dc6d9b7fb..4b12f944ca44 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -1464,6 +1464,8 @@
gpio-mockup.gpio_mockup_ranges
[HW] Sets the ranges of gpiochip of for this device.
Format: <start1>,<end1>,<start2>,<end2>...
+ gpio-mockup.gpio_mockup_named_lines
+ [HW] Let the driver know GPIO lines should be named.
gpt [EFI] Forces disk with valid GPT signature but
invalid Protective MBR to be treated as GPT. If the
--
2.20.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* Re: [PATCH 1/3] docs: gpio: mockup: Fix parameter name
2021-03-29 11:16 ` [PATCH 1/3] docs: gpio: mockup: Fix parameter name Alexander Dahl
@ 2021-03-31 7:44 ` Bartosz Golaszewski
2021-03-31 12:27 ` Andy Shevchenko
1 sibling, 0 replies; 10+ messages in thread
From: Bartosz Golaszewski @ 2021-03-31 7:44 UTC (permalink / raw)
To: Alexander Dahl
Cc: linux-doc, linux-gpio, LKML, Linus Walleij, Jonathan Corbet
On Mon, Mar 29, 2021 at 1:17 PM Alexander Dahl <ada@thorsis.com> wrote:
>
> Module probing with the parameter documented yielded this in kernel log:
>
> gpio_mockup: unknown parameter 'gpio_named_lines' ignored
>
> The parameter documented did not match the parameter actually
> implemented with commit 8a68ea00a62e ("gpio: mockup: implement naming
> the lines") long before introducing the documentation.
>
> Fixes: commit 2fd1abe99e5f ("Documentation: gpio: add documentation for gpio-mockup")
> Signed-off-by: Alexander Dahl <ada@thorsis.com>
> ---
> Documentation/admin-guide/gpio/gpio-mockup.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/admin-guide/gpio/gpio-mockup.rst b/Documentation/admin-guide/gpio/gpio-mockup.rst
> index 9fa1618b3adc..e3cafb4451aa 100644
> --- a/Documentation/admin-guide/gpio/gpio-mockup.rst
> +++ b/Documentation/admin-guide/gpio/gpio-mockup.rst
> @@ -27,7 +27,7 @@ module.
> the second 16 and the third 4. The base GPIO for the third chip is set
> to 405 while for two first chips it will be assigned automatically.
>
> - gpio_named_lines
> + gpio_mockup_named_lines
>
> This parameter doesn't take any arguments. It lets the driver know that
> GPIO lines exposed by it should be named.
> --
> 2.20.1
>
This was already fixed by Andy.
Bartosz
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH 2/3] docs: kernel-parameters: Move gpio-mockup for alphabetic order
2021-03-29 11:16 ` [PATCH 2/3] docs: kernel-parameters: Move gpio-mockup for alphabetic order Alexander Dahl
@ 2021-03-31 7:46 ` Bartosz Golaszewski
0 siblings, 0 replies; 10+ messages in thread
From: Bartosz Golaszewski @ 2021-03-31 7:46 UTC (permalink / raw)
To: Alexander Dahl
Cc: linux-doc, linux-gpio, LKML, Linus Walleij, Jonathan Corbet
On Mon, Mar 29, 2021 at 1:17 PM Alexander Dahl <ada@thorsis.com> wrote:
>
> Fixes: commit 0f98dd1b27d2 ("gpio/mockup: add virtual gpio device")
> Signed-off-by: Alexander Dahl <ada@thorsis.com>
> ---
Applied, thanks!
Bartosz
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH 3/3] docs: kernel-parameters: Add gpio_mockup_named_lines
2021-03-29 11:16 ` [PATCH 3/3] docs: kernel-parameters: Add gpio_mockup_named_lines Alexander Dahl
@ 2021-03-31 7:46 ` Bartosz Golaszewski
0 siblings, 0 replies; 10+ messages in thread
From: Bartosz Golaszewski @ 2021-03-31 7:46 UTC (permalink / raw)
To: Alexander Dahl
Cc: linux-doc, linux-gpio, LKML, Linus Walleij, Jonathan Corbet
On Mon, Mar 29, 2021 at 1:17 PM Alexander Dahl <ada@thorsis.com> wrote:
>
> Missing since introduced in the driver.
>
> Fixes: commit 8a68ea00a62e ("gpio: mockup: implement naming the lines")
> Signed-off-by: Alexander Dahl <ada@thorsis.com>
> ---
Applied, thanks!
Bartosz
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH 1/3] docs: gpio: mockup: Fix parameter name
2021-03-29 11:16 ` [PATCH 1/3] docs: gpio: mockup: Fix parameter name Alexander Dahl
2021-03-31 7:44 ` Bartosz Golaszewski
@ 2021-03-31 12:27 ` Andy Shevchenko
2021-03-31 12:53 ` Alexander Dahl
1 sibling, 1 reply; 10+ messages in thread
From: Andy Shevchenko @ 2021-03-31 12:27 UTC (permalink / raw)
To: Alexander Dahl
Cc: Linux Documentation List, open list:GPIO SUBSYSTEM,
Linux Kernel Mailing List, Linus Walleij, Bartosz Golaszewski,
Jonathan Corbet
On Mon, Mar 29, 2021 at 2:18 PM Alexander Dahl <ada@thorsis.com> wrote:
>
> Module probing with the parameter documented yielded this in kernel log:
>
> gpio_mockup: unknown parameter 'gpio_named_lines' ignored
>
> The parameter documented did not match the parameter actually
> implemented with commit 8a68ea00a62e ("gpio: mockup: implement naming
> the lines") long before introducing the documentation.
>
> Fixes: commit 2fd1abe99e5f ("Documentation: gpio: add documentation for gpio-mockup")
Alexander, in the entire series you are using the wrong format for the
Fixes tag.
I highly recommend to add in your .gitconfig file an alias:
one = show -s --pretty='format:%h (\"%s\")'
`git one <commit ID>` will give you proper value to refer to the
commit in question.
--
With Best Regards,
Andy Shevchenko
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH 1/3] docs: gpio: mockup: Fix parameter name
2021-03-31 12:27 ` Andy Shevchenko
@ 2021-03-31 12:53 ` Alexander Dahl
2021-03-31 18:31 ` Bartosz Golaszewski
0 siblings, 1 reply; 10+ messages in thread
From: Alexander Dahl @ 2021-03-31 12:53 UTC (permalink / raw)
To: Andy Shevchenko
Cc: Alexander Dahl, Linux Documentation List,
open list:GPIO SUBSYSTEM, Linux Kernel Mailing List,
Linus Walleij, Bartosz Golaszewski, Jonathan Corbet
Hello Andy,
Am Wed, Mar 31, 2021 at 03:27:05PM +0300 schrieb Andy Shevchenko:
> On Mon, Mar 29, 2021 at 2:18 PM Alexander Dahl <ada@thorsis.com> wrote:
> >
> > Module probing with the parameter documented yielded this in kernel log:
> >
> > gpio_mockup: unknown parameter 'gpio_named_lines' ignored
> >
> > The parameter documented did not match the parameter actually
> > implemented with commit 8a68ea00a62e ("gpio: mockup: implement naming
> > the lines") long before introducing the documentation.
> >
> > Fixes: commit 2fd1abe99e5f ("Documentation: gpio: add documentation for gpio-mockup")
>
> Alexander, in the entire series you are using the wrong format for the
> Fixes tag.
> I highly recommend to add in your .gitconfig file an alias:
> one = show -s --pretty='format:%h (\"%s\")'
You're right. Sorry, I messed things up. I first had that line without
the additional "commit", and added it because I thought checkpatch
complained (which it probably did not).
The actual format is documented of course:
https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
I actually have a slightly different setting for pretty.fixes in my
~/.gitconfig for other demands. I'll go and make that project
dependent now.
Thanks for pointing this out.
Greets
Alex
>
> `git one <commit ID>` will give you proper value to refer to the
> commit in question.
>
> --
> With Best Regards,
> Andy Shevchenko
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH 1/3] docs: gpio: mockup: Fix parameter name
2021-03-31 12:53 ` Alexander Dahl
@ 2021-03-31 18:31 ` Bartosz Golaszewski
0 siblings, 0 replies; 10+ messages in thread
From: Bartosz Golaszewski @ 2021-03-31 18:31 UTC (permalink / raw)
To: Andy Shevchenko, Linux Documentation List,
open list:GPIO SUBSYSTEM, Linux Kernel Mailing List,
Linus Walleij, Bartosz Golaszewski, Jonathan Corbet
Cc: Alexander Dahl
On Wed, Mar 31, 2021 at 2:53 PM Alexander Dahl <ada@thorsis.com> wrote:
>
> Hello Andy,
>
> Am Wed, Mar 31, 2021 at 03:27:05PM +0300 schrieb Andy Shevchenko:
> > On Mon, Mar 29, 2021 at 2:18 PM Alexander Dahl <ada@thorsis.com> wrote:
> > >
> > > Module probing with the parameter documented yielded this in kernel log:
> > >
> > > gpio_mockup: unknown parameter 'gpio_named_lines' ignored
> > >
> > > The parameter documented did not match the parameter actually
> > > implemented with commit 8a68ea00a62e ("gpio: mockup: implement naming
> > > the lines") long before introducing the documentation.
> > >
> > > Fixes: commit 2fd1abe99e5f ("Documentation: gpio: add documentation for gpio-mockup")
> >
> > Alexander, in the entire series you are using the wrong format for the
> > Fixes tag.
> > I highly recommend to add in your .gitconfig file an alias:
> > one = show -s --pretty='format:%h (\"%s\")'
>
> You're right. Sorry, I messed things up. I first had that line without
> the additional "commit", and added it because I thought checkpatch
> complained (which it probably did not).
>
> The actual format is documented of course:
>
> https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
>
> I actually have a slightly different setting for pretty.fixes in my
> ~/.gitconfig for other demands. I'll go and make that project
> dependent now.
>
> Thanks for pointing this out.
>
> Greets
> Alex
>
> >
> > `git one <commit ID>` will give you proper value to refer to the
> > commit in question.
> >
> > --
> > With Best Regards,
> > Andy Shevchenko
FYI no need to resend, I fixed it in my tree.
Bart
^ permalink raw reply [flat|nested] 10+ messages in thread
end of thread, other threads:[~2021-03-31 18:32 UTC | newest]
Thread overview: 10+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-29 11:16 [PATCH 0/3] docs: gpio: mockup: Fix parameter name and missing entry Alexander Dahl
2021-03-29 11:16 ` [PATCH 1/3] docs: gpio: mockup: Fix parameter name Alexander Dahl
2021-03-31 7:44 ` Bartosz Golaszewski
2021-03-31 12:27 ` Andy Shevchenko
2021-03-31 12:53 ` Alexander Dahl
2021-03-31 18:31 ` Bartosz Golaszewski
2021-03-29 11:16 ` [PATCH 2/3] docs: kernel-parameters: Move gpio-mockup for alphabetic order Alexander Dahl
2021-03-31 7:46 ` Bartosz Golaszewski
2021-03-29 11:16 ` [PATCH 3/3] docs: kernel-parameters: Add gpio_mockup_named_lines Alexander Dahl
2021-03-31 7:46 ` Bartosz Golaszewski
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).