MAINTAINERS: treat Documentation/maintainer as process docs

[PATCH docs v2] MAINTAINERS: treat Documentation/maintainer as process docs

Posted by Jakub Kicinski 2 years, 6 months ago

A handful of people got caught out by the recent changes in git
which changed the format of Message-ID and broke our recommended
applyhook for adding lore links.

This was fixed in the docs by commit 2bb19e740e9b ("Documentation:
update git configuration for Link: tag") but it seems like few people
have noticed. Add maintainer directory to the process entry so that
workflows@ gets CCed.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
v2:
 - fix order of entries
v1: https://lore.kernel.org/all/20230712161011.1339829-1-kuba@kernel.org/
---
 MAINTAINERS | 1 +
 1 file changed, 1 insertion(+)

diff --git a/MAINTAINERS b/MAINTAINERS
index 3be1bdfe8ecc..fff7e50948b6 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -6206,6 +6206,7 @@ DOCUMENTATION PROCESS
 M:	Jonathan Corbet <corbet@lwn.net>
 L:	workflows@vger.kernel.org
 S:	Maintained
+F:	Documentation/maintainer/
 F:	Documentation/process/
 
 DOCUMENTATION REPORTING ISSUES
-- 
2.41.0

Re: [PATCH docs v2] MAINTAINERS: treat Documentation/maintainer as process docs

Posted by Randy Dunlap 2 years, 6 months ago

Hi,

On 7/13/23 16:07, Jakub Kicinski wrote:
> A handful of people got caught out by the recent changes in git
> which changed the format of Message-ID and broke our recommended
> applyhook for adding lore links.
> 
> This was fixed in the docs by commit 2bb19e740e9b ("Documentation:
> update git configuration for Link: tag") but it seems like few people
> have noticed. Add maintainer directory to the process entry so that
> workflows@ gets CCed.
> 
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.

Not your problem, but I find "DOCUMENTATION PROCESS" confusing.
It's not about the documentation process. IMO it needs a colon
at least:
DOCUMENTATION: PROCESS
or
DOCUMENTATION: DEVELOPMENT PROCESS


> ---
> v2:
>  - fix order of entries
> v1: https://lore.kernel.org/all/20230712161011.1339829-1-kuba@kernel.org/
> ---
>  MAINTAINERS | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 3be1bdfe8ecc..fff7e50948b6 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -6206,6 +6206,7 @@ DOCUMENTATION PROCESS
>  M:	Jonathan Corbet <corbet@lwn.net>
>  L:	workflows@vger.kernel.org
>  S:	Maintained
> +F:	Documentation/maintainer/
>  F:	Documentation/process/
>  
>  DOCUMENTATION REPORTING ISSUES

-- 
~Randy

Re: [PATCH docs v2] MAINTAINERS: treat Documentation/maintainer as process docs

Posted by Jonathan Corbet 2 years, 6 months ago

Jakub Kicinski <kuba@kernel.org> writes:

> A handful of people got caught out by the recent changes in git
> which changed the format of Message-ID and broke our recommended
> applyhook for adding lore links.
>
> This was fixed in the docs by commit 2bb19e740e9b ("Documentation:
> update git configuration for Link: tag") but it seems like few people
> have noticed. Add maintainer directory to the process entry so that
> workflows@ gets CCed.
>
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> ---
> v2:
>  - fix order of entries
> v1: https://lore.kernel.org/all/20230712161011.1339829-1-kuba@kernel.org/
> ---
>  MAINTAINERS | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 3be1bdfe8ecc..fff7e50948b6 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -6206,6 +6206,7 @@ DOCUMENTATION PROCESS
>  M:	Jonathan Corbet <corbet@lwn.net>
>  L:	workflows@vger.kernel.org
>  S:	Maintained
> +F:	Documentation/maintainer/
>  F:	Documentation/process/

So what this may really be telling us is that we should move the
maintainer directory under Documentation/process/.  But applying this
patch is easier, so that's what I've done for now :)

Thanks,

jon