From: Rodrigo Siqueira <rodrigosiqueiramelo@gmail.com>
To: Jonathan Cameron <jic23@kernel.org>
Cc: Hartmut Knaack <knaack.h@gmx.de>,
Lars-Peter Clausen <lars@metafoo.de>,
Peter Meerwald-Stadler <pmeerw@pmeerw.net>,
daniel.baluta@nxp.com, kernel-janitors@vger.kernel.org,
linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] iio:dummy: Fix coding style in Kconfig
Date: Sat, 24 Feb 2018 09:36:09 -0300 [thread overview]
Message-ID: <20180224123609.ysidednaigprxq7m@smtp.gmail.com> (raw)
In-Reply-To: <20180224122428.007ccf89@archlinux>
On 02/24, Jonathan Cameron wrote:
> On Tue, 20 Feb 2018 10:28:04 -0300
> Rodrigo Siqueira <rodrigosiqueiramelo@gmail.com> wrote:
>
> > This patch fixes the checkpatch.pl warning:
> >
> > drivers/iio/dummy/Kconfig:21: WARNING: please write a paragraph that
> > describes the config symbol fully
> > drivers/iio/dummy/Kconfig:29: WARNING: please write a paragraph that
> > describes the config symbol fully
> >
> > This patch expands the explanation about IIO_DUMMY_EVGEN by using the
> > code documentation found in iio/dummy/iio_dummy_evgen.c. In the same
> > way, the information related to IIO_SIMPLE_DUMMY_BUFFER was extracted
> > from file iio_simple_dummy_buffer.c. Finally, this patch apply the
> > coding-style for Kconfig files (Documentation/process/coding-style.rst)
> >
> > Signed-off-by: Rodrigo Siqueira <rodrigosiqueiramelo@gmail.com>
>
> Several different things going on in the one patch, please do
> it as a short series with one thing per patch.
>
> Certainly do the coding style separately from the additional documentation.
>
> Thanks,
>
> Jonathan
So, should I split it into two different patches? One patch for the fix
and other for the extra documentation?
Finally, in the two warnings related to "please write a paragraph that
describes the config symbol fully" the extra documentation that fixes
it. Other fixes, are related to the coding-style.rst however checkpatch
does not complain about them.
>
> > ---
> > drivers/iio/dummy/Kconfig | 26 ++++++++++++++++----------
> > 1 file changed, 16 insertions(+), 10 deletions(-)
> >
> > diff --git a/drivers/iio/dummy/Kconfig b/drivers/iio/dummy/Kconfig
> > index 5a29fbd3c531..4a7127fb2979 100644
> > --- a/drivers/iio/dummy/Kconfig
> > +++ b/drivers/iio/dummy/Kconfig
> > @@ -9,20 +9,24 @@ config IIO_DUMMY_EVGEN
> > tristate
> >
> > config IIO_SIMPLE_DUMMY
> > - tristate "An example driver with no hardware requirements"
> > - depends on IIO_SW_DEVICE
> > - help
> > - Driver intended mainly as documentation for how to write
> > - a driver. May also be useful for testing userspace code
> > - without hardware.
> > + tristate "An example driver with no hardware requirements"
> > + depends on IIO_SW_DEVICE
> > + help
> > + Driver intended mainly as documentation for how to write
> > + a driver. May also be useful for testing userspace code
> > + without hardware.
> >
> > if IIO_SIMPLE_DUMMY
> >
> > config IIO_SIMPLE_DUMMY_EVENTS
> > - bool "Event generation support"
> > - select IIO_DUMMY_EVGEN
> > - help
> > - Add some dummy events to the simple dummy driver.
> > + bool "Event generation support"
> > + select IIO_DUMMY_EVGEN
> > + help
> > + Add some dummy events to the simple dummy driver.
> > +
> > + The purpose of this is to generate 'fake' event interrupts thus
> > + allowing that driver's code to be as close as possible to that
> > + a normal driver talking to hardware.
> >
> > config IIO_SIMPLE_DUMMY_BUFFER
> > bool "Buffered capture support"
> > @@ -32,6 +36,8 @@ config IIO_SIMPLE_DUMMY_BUFFER
> > help
> > Add buffered data capture to the simple dummy driver.
> >
> > + Buffer handling elements of industrial I/O reference driver.
> > + Uses the kfifo buffer.
> > endif # IIO_SIMPLE_DUMMY
> >
> > endmenu
>
next prev parent reply other threads:[~2018-02-24 12:36 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-02-20 13:28 [PATCH] iio:dummy: Fix coding style in Kconfig Rodrigo Siqueira
2018-02-24 12:24 ` Jonathan Cameron
2018-02-24 12:36 ` Rodrigo Siqueira [this message]
2018-02-24 13:44 ` Jonathan Cameron
2018-02-24 13:53 ` Rodrigo Siqueira
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=20180224123609.ysidednaigprxq7m@smtp.gmail.com \
--to=rodrigosiqueiramelo@gmail.com \
--cc=daniel.baluta@nxp.com \
--cc=jic23@kernel.org \
--cc=kernel-janitors@vger.kernel.org \
--cc=knaack.h@gmx.de \
--cc=lars@metafoo.de \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=pmeerw@pmeerw.net \
/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).