[PATCH v2] docs: MAINTAINERS: add "Profile" keyword entry name

[PATCH v2] docs: MAINTAINERS: add "Profile" keyword entry name

[Krzysztof Kozlowski]

The HTML output of MAINTAINERS file prints "P:" for subsystem profile,
e.g.:
	Status:   Maintained
	P:        process/maintainer-soc-clean-dts

Use "Profile" as this entry name.

Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

---

Changes in v2:
1. Drop duplicated "Profile" word.
---
 MAINTAINERS | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index b9c3100ef587..36fac6b3499a 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -24,7 +24,7 @@ Descriptions of section entries and preferred order
 	   filing info, a direct bug tracker link, or a mailto: URI.
 	C: URI for *chat* protocol, server and channel where developers
 	   usually hang out, for example irc://server/channel.
-	P: Subsystem Profile document for more details submitting
+	P: Subsystem *Profile* document for more details submitting
 	   patches to the given subsystem. This is either an in-tree file,
 	   or a URI. See Documentation/maintainer/maintainer-entry-profile.rst
 	   for details.
-- 
2.34.1

Re: [PATCH v2] docs: MAINTAINERS: add "Profile" keyword entry name

[Kalle Valo]

Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> writes:

> The HTML output of MAINTAINERS file prints "P:" for subsystem profile,
> e.g.:
> 	Status:   Maintained
> 	P:        process/maintainer-soc-clean-dts
>
> Use "Profile" as this entry name.
>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

Heh, I was confused what HTML file Krzysztof was talking about but after
some digging I found this:

https://docs.kernel.org/process/maintainers.html

This is very useful! You can link directly to entries[1] and it's easy
to read which makes it easier to talk with non-technical people.

Jonathan, I wish we would make this HTML version more visible, for
example what about adding a link to the HTML version in beginning of the
file? And maybe add a short introduction text at the same time? I can
send a patch if there's interest.

[1] https://docs.kernel.org/process/maintainers.html#qualcomm-atheros-ath10k-wireless-driver

-- 
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches

Re: [PATCH v2] docs: MAINTAINERS: add "Profile" keyword entry name

[Jonathan Corbet]

Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> writes:

> The HTML output of MAINTAINERS file prints "P:" for subsystem profile,
> e.g.:
> 	Status:   Maintained
> 	P:        process/maintainer-soc-clean-dts
>
> Use "Profile" as this entry name.
>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
>
> ---
>
> Changes in v2:
> 1. Drop duplicated "Profile" word.
> ---
>  MAINTAINERS | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index b9c3100ef587..36fac6b3499a 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -24,7 +24,7 @@ Descriptions of section entries and preferred order
>  	   filing info, a direct bug tracker link, or a mailto: URI.
>  	C: URI for *chat* protocol, server and channel where developers
>  	   usually hang out, for example irc://server/channel.
> -	P: Subsystem Profile document for more details submitting
> +	P: Subsystem *Profile* document for more details submitting
>  	   patches to the given subsystem. This is either an in-tree file,

I would have taken this but ... SeongJae beat you to it by a few days:

  https://lore.kernel.org/r/20240216201902.10095-1-sj@kernel.org

Thanks,

jon

Re: [PATCH v2] docs: MAINTAINERS: add "Profile" keyword entry name

[Jonathan Corbet]

Kalle Valo <kvalo@kernel.org> writes:

> Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> writes:
>
>> The HTML output of MAINTAINERS file prints "P:" for subsystem profile,
>> e.g.:
>> 	Status:   Maintained
>> 	P:        process/maintainer-soc-clean-dts
>>
>> Use "Profile" as this entry name.
>>
>> Cc: Jonathan Corbet <corbet@lwn.net>
>> Cc: linux-doc@vger.kernel.org
>> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
>
> Heh, I was confused what HTML file Krzysztof was talking about but after
> some digging I found this:
>
> https://docs.kernel.org/process/maintainers.html
>
> This is very useful! You can link directly to entries[1] and it's easy
> to read which makes it easier to talk with non-technical people.

Non-technical people like ... maintainers? :)

> Jonathan, I wish we would make this HTML version more visible, for
> example what about adding a link to the HTML version in beginning of the
> file? And maybe add a short introduction text at the same time? I can
> send a patch if there's interest.

I'll certainly entertain a patch but ... I feel like the same could be
said for any file within Documentation/.  Perhaps we should make the
rendered docs on kernel.org more discoverable, but I'm not sure that the
maintainers manual is the place to start...?

Thanks,

jon