Re: [PATCH v3 3/5] drivers/soc/litex: add LiteX SoC Controller driver

From: Mateusz Holenko
Date: Tue Mar 17 2020 - 04:26:55 EST


On Tue, Feb 25, 2020 at 5:16 PM Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:
>
> On 2/25/20 12:46 AM, Mateusz Holenko wrote:
> > diff --git a/drivers/soc/litex/Kconfig b/drivers/soc/litex/Kconfig
> > new file mode 100644
> > index 000000000000..22c78cda0b83
> > --- /dev/null
> > +++ b/drivers/soc/litex/Kconfig
> > @@ -0,0 +1,14 @@
> > +# SPDX-License_Identifier: GPL-2.0
> > +
> > +menu "Enable LiteX SoC Builder specific drivers"
> > +
> > +config LITEX_SOC_CONTROLLER
> > + tristate "Enable LiteX SoC Controller driver"
> > + help
> > + This option enables the SoC Controller Driver which verifies
> > + LiteX CSR access and provides common litex_get_reg/litex_set_reg
> > + accessors.
> > + All drivers that use functions from litex.h must depend on
> > + LITEX_SOC_CONTROLLER
>
> Hi,
> Please indent the help text with 2 additional spaces, as explained in the
> coding-style.rst file:
>
> 10) Kconfig configuration files
> -------------------------------
>
> For all of the Kconfig* configuration files throughout the source tree,
> the indentation is somewhat different. Lines under a ``config`` definition
> are indented with one tab, while help text is indented an additional two
> spaces. Example::
>
> config AUDIT
> bool "Auditing support"
> depends on NET
> help
> Enable auditing infrastructure that can be used with another
> kernel subsystem, such as SELinux (which requires this for
> logging of avc messages output). Does not do system-call
> auditing without CONFIG_AUDITSYSCALL.
>
> > +
> > +endmenu
>
> and then end the last line of the help text with a period ('.').
>
> thanks.
>
> --
> ~Randy
>

Thanks for the comments!

I'll fix the documentation and resubmit the patch after addressing all
other remarks.

--
Mateusz Holenko
Antmicro Ltd | www.antmicro.com
Roosevelta 22, 60-829 Poznan, Poland