linux-kernel - Re: [RFC PATCH v3] docs-rst: user: add MAINTAINERS

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Fri, 23 Sep 2016 14:50:56 -0300
From:   Mauro Carvalho Chehab <mchehab@...pensource.com>
To:     Joe Perches <joe@...ches.com>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        Mauro Carvalho Chehab <mchehab@...nel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>
Subject: Re: [RFC PATCH v3] docs-rst: user: add MAINTAINERS

Em Fri, 23 Sep 2016 09:26:34 -0700
Joe Perches <joe@...ches.com> escreveu:

> On Fri, 2016-09-23 at 12:07 -0300, Mauro Carvalho Chehab wrote:
> > So, let's use an unusual approach: manually convert the
> > text at the MAINTAINERS file head, adding it at a new
> > Documentation/user/MAINTAINERS.rst, and include, as a code
> > block, the rest of MAINTAINERS contents, with only the
> > contents of the maintainers entries.
> > 
> > There's a side effect of this approach: now, if the
> > explanation text at the MAINTAINERS file is touched, it should be
> > modified also at the Documentation/user/MAINTAINERS.rst file.
> > Yet, as the number of changes there are small, this
> > should be manageable.  
> 
> couldn't this be a generated file from some awk script instead
> of being duplicated content with a plea to be kept in sync?

Yes, using a script (awk/perl/bash/python/....) is another alternative. 

In such case, we would need to either generate it via Makefile or
to have a Sphinx extension that would tell what script to run.

I actually think that a generic include-like Sphinx extension that
would run a script and use its result as an included text could be
interesting, as it would be a way to get rid of the 
Documentation/media Makefile.

Thanks,
Mauro