diff mbox series

[1/3] docs: gpio: mockup: Fix parameter name

Message ID 20210329111648.7969-2-ada@thorsis.com
State Rejected
Headers show
Series docs: gpio: mockup: Fix parameter name and missing entry | expand

Commit Message

Alexander Dahl March 29, 2021, 11:16 a.m. UTC
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(-)

Comments

Bartosz Golaszewski March 31, 2021, 7:44 a.m. UTC | #1
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
Andy Shevchenko March 31, 2021, 12:27 p.m. UTC | #2
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.
Alexander Dahl March 31, 2021, 12:53 p.m. UTC | #3
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
Bartosz Golaszewski March 31, 2021, 6:31 p.m. UTC | #4
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
diff mbox series

Patch

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.