| Message ID | 20190210181011.6117-1-lukas.bulwahn@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | MAINTAINERS: use tab instead of spaces | expand |
On 2/10/19 10:10 AM, Lukas Bulwahn wrote: > Mimi Zohar used spaces instead of a tab when adding Jarkko Sakkinen as > further maintainer to the KEYS-TRUSTED section entry. So, we rectify this > with this commit. > > The issue was detected when writing a script that parses MAINTAINERS. > > Fixes: 34bccd61b139 ("MAINTAINERS: add Jarkko as maintainer for trusted keys") > Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> > --- > Mimi, please pick up this patch. Thanks. > > MAINTAINERS | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/MAINTAINERS b/MAINTAINERS > index bf4965d6d5de..31950caabcaf 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -8405,7 +8405,7 @@ F: security/keys/encrypted-keys/ > > KEYS-TRUSTED > M: James Bottomley <jejb@linux.ibm.com> > -M: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> > +M: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> > M: Mimi Zohar <zohar@linuxibm.com> Just checking: is that email address correct (@linuxibm.com)? Guess I'll see if it bounces. > L: linux-integrity@vger.kernel.org > L: keyrings@vger.kernel.org >
On Sun, 2019-02-10 at 19:10 +0100, Lukas Bulwahn wrote: > Mimi Zohar used spaces instead of a tab when adding Jarkko Sakkinen > as > further maintainer to the KEYS-TRUSTED section entry. So, we rectify > this > with this commit. > > The issue was detected when writing a script that parses MAINTAINERS. > > Fixes: 34bccd61b139 ("MAINTAINERS: add Jarkko as maintainer for > trusted keys") > Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> This isn't really a bug, is it? We have no formatting requirements for the MAINTAINERS file and the section owner is free to align with tabs, spaces or nothing as they see fit. Most use a single tab, but a couple don't. The only real thing that cares is get_maintainers.pl and it uses \s* as the parse regexp, so it doesn't care either. Now, we could possibly agree the file looks better with a single space or a single tab between the tag and the value and thus we should be doing this, but we'd need to agree on that and update the tag description accordingly. James
On Sun, Feb 10, 2019 at 7:22 PM Randy Dunlap <rdunlap@infradead.org> wrote: > > On 2/10/19 10:10 AM, Lukas Bulwahn wrote: > > M: James Bottomley <jejb@linux.ibm.com> > > -M: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> > > +M: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> > > M: Mimi Zohar <zohar@linuxibm.com> > > Just checking: is that email address correct (@linuxibm.com)? > > Guess I'll see if it bounces. > Yes, it bounces. A follow-up patch is coming in a minute. Lukas
On Sun, 10 Feb 2019, James Bottomley wrote: > On Sun, 2019-02-10 at 19:10 +0100, Lukas Bulwahn wrote: > > Mimi Zohar used spaces instead of a tab when adding Jarkko Sakkinen > > as > > further maintainer to the KEYS-TRUSTED section entry. So, we rectify > > this > > with this commit. > > > > The issue was detected when writing a script that parses MAINTAINERS. > > > > Fixes: 34bccd61b139 ("MAINTAINERS: add Jarkko as maintainer for > > trusted keys") > > Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> > > This isn't really a bug, is it? > > We have no formatting requirements for the MAINTAINERS file and the > section owner is free to align with tabs, spaces or nothing as they see > fit. Most use a single tab, but a couple don't. The only real thing > that cares is get_maintainers.pl and it uses \s* as the parse regexp, > so it doesn't care either. > > Now, we could possibly agree the file looks better with a single space > or a single tab between the tag and the value and thus we should be > doing this, but we'd need to agree on that and update the tag > description accordingly. > It was the only line in MAINTAINERS remaining that used spaces instead of a single tab. So, even if there is not an explicit formatting requirement, changing a single line to have it consistent in one format seemed reasonable to me. I just sent a new patch that also corrected the email address; unfortunately, I was distracted and sent it out wrong twice before getting Mimi's email right on the third try. Please ignore this patch and consider the patch: MAINTAINERS: rectify two issues in KEYS-TRUSTED entry Thanks, Lukas
On Sun, 2019-02-10 at 19:10 +0100, Lukas Bulwahn wrote: > Mimi Zohar used spaces instead of a tab when adding Jarkko Sakkinen as > further maintainer to the KEYS-TRUSTED section entry. So, we rectify this > with this commit. > > The issue was detected when writing a script that parses MAINTAINERS. checkpatch already does that btw: $ ./scripts/checkpatch.pl -f MAINTAINERS WARNING: MAINTAINERS entries use one tab after TYPE: #8408: FILE: MAINTAINERS:8408: +M: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> WARNING: MAINTAINERS entries use one tab after TYPE: #12607: FILE: MAINTAINERS:12607: +M: Ilia Lin <ilia.lin@gmail.com> WARNING: MAINTAINERS entries use one tab after TYPE: #12608: FILE: MAINTAINERS:12608: +L: linux-pm@vger.kernel.org WARNING: MAINTAINERS entries use one tab after TYPE: #12609: FILE: MAINTAINERS:12609: +S: Maintained WARNING: MAINTAINERS entries use one tab after TYPE: #12610: FILE: MAINTAINERS:12610: +F: Documentation/devicetree/bindings/opp/kryo-cpufreq.txt WARNING: MAINTAINERS entries use one tab after TYPE: #12611: FILE: MAINTAINERS:12611: +F: drivers/cpufreq/qcom-cpufreq-kryo.c total: 0 errors, 6 warnings, 16993 lines checked NOTE: For some of the reported defects, checkpatch may be able to mechanically convert to the typical style using --fix or --fix-inplace
On Sun, 2019-02-10 at 10:25 -0800, James Bottomley wrote: > On Sun, 2019-02-10 at 19:10 +0100, Lukas Bulwahn wrote: > > Mimi Zohar used spaces instead of a tab when adding Jarkko Sakkinen > > as > > further maintainer to the KEYS-TRUSTED section entry. So, we rectify > > this > > with this commit. > > > > The issue was detected when writing a script that parses MAINTAINERS. > > > > Fixes: 34bccd61b139 ("MAINTAINERS: add Jarkko as maintainer for > > trusted keys") > > Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> > > This isn't really a bug, is it? No, it's a style defect. > We have no formatting requirements for the MAINTAINERS file and the > section owner is free to align with tabs, spaces or nothing as they see > fit. Most use a single tab, but a couple don't. The only real thing > that cares is get_maintainers.pl and it uses \s* as the parse regexp, > so it doesn't care either. Not really. It doesn't 'care' because get_maintainer is designed to work with badly formatted entries. checkpatch does emit warnings for MAINTAINER entries that use anything other than a single tab.
iOn Sun, 10 Feb 2019, Joe Perches wrote: > On Sun, 2019-02-10 at 19:10 +0100, Lukas Bulwahn wrote: > > Mimi Zohar used spaces instead of a tab when adding Jarkko Sakkinen as > > further maintainer to the KEYS-TRUSTED section entry. So, we rectify this > > with this commit. > > > > The issue was detected when writing a script that parses MAINTAINERS. > > checkpatch already does that btw: Good to know. > > $ ./scripts/checkpatch.pl -f MAINTAINERS > WARNING: MAINTAINERS entries use one tab after TYPE: > #8408: FILE: MAINTAINERS:8408: > +M: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> > > WARNING: MAINTAINERS entries use one tab after TYPE: > #12607: FILE: MAINTAINERS:12607: > +M: Ilia Lin <ilia.lin@gmail.com> > > WARNING: MAINTAINERS entries use one tab after TYPE: > #12608: FILE: MAINTAINERS:12608: > +L: linux-pm@vger.kernel.org > > WARNING: MAINTAINERS entries use one tab after TYPE: > #12609: FILE: MAINTAINERS:12609: > +S: Maintained > > WARNING: MAINTAINERS entries use one tab after TYPE: > #12610: FILE: MAINTAINERS:12610: > +F: Documentation/devicetree/bindings/opp/kryo-cpufreq.txt > > WARNING: MAINTAINERS entries use one tab after TYPE: > #12611: FILE: MAINTAINERS:12611: > +F: drivers/cpufreq/qcom-cpufreq-kryo.c > > total: 0 errors, 6 warnings, 16993 lines checked > > NOTE: For some of the reported defects, checkpatch may be able to > mechanically convert to the typical style using --fix or --fix-inplace > On next-20190211, the checkpatch issues in line 12607 to 12611 are not reported anymore, as I already fixed them in commit 70e6e7d92bca ("MAINTAINERS: use common indentation"). So, the issue addressed here and in the later follow-up patch is the only style-related issue in MAINTAINERS. After that, everything in MAINTAINERS is stylistically clean. Lukas
diff --git a/MAINTAINERS b/MAINTAINERS index bf4965d6d5de..31950caabcaf 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -8405,7 +8405,7 @@ F: security/keys/encrypted-keys/ KEYS-TRUSTED M: James Bottomley <jejb@linux.ibm.com> -M: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> +M: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> M: Mimi Zohar <zohar@linuxibm.com> L: linux-integrity@vger.kernel.org L: keyrings@vger.kernel.org
Mimi Zohar used spaces instead of a tab when adding Jarkko Sakkinen as further maintainer to the KEYS-TRUSTED section entry. So, we rectify this with this commit. The issue was detected when writing a script that parses MAINTAINERS. Fixes: 34bccd61b139 ("MAINTAINERS: add Jarkko as maintainer for trusted keys") Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> --- Mimi, please pick up this patch. Thanks. MAINTAINERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)