[Linux-kernel-mentees] [PATCH] Documentation: MAINTAINERS: add information about parse-maintainers.pl

Aditya yashsri421 at gmail.com
Fri Nov 20 10:16:19 UTC 2020


On 20/11/20 3:42 pm, Aditya Srivastava wrote:
> parse-maintainers.pl is a script which can be used to automatically
> order the contents of MAINTAINERS file in preferred order (i.e.
> 'MRLSWQBCPTFXNK').
> 
> But currently we don't have a documentation on it.
> 
> Add documentation regarding the same in MAINTAINERS file.
> 
> Signed-off-by: Aditya Srivastava <yashsri421 at gmail.com>
> ---
> the patch applies perfectly on latest next-20201119
> 
>  MAINTAINERS | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 5db753fa1295..7ad00af7acd4 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -136,6 +136,9 @@ Descriptions of section entries and preferred order
>  	      printk, pr_info or pr_err
>  	   One regex pattern per line.  Multiple K: lines acceptable.
>  
> +This order can be generated automatically for you using
> +``scripts/parse-maintainers.pl``.
> +
>  Maintainers List
>  ----------------
>  
> 

Rationale for my changes:
I did not go into much detail of its working here.
A bit detail on this can be to use 'scripts/parse-maintainers
--sorted' which produces the sorted file in MAINTAINERS.new by
default. The input and output default files can be changed using
'--input' and '--output' options. However, here I have omitted these
details as running with '--help' option already provides this
information in detail.
So just making user aware of the script should serve our purpose.

What do you think?

Thanks
Aditya


More information about the Linux-kernel-mentees mailing list