[PATCH] docs: maintainer: Fix capitalization

Thorsten Blum posted 1 patch 2 weeks, 2 days ago
Documentation/maintainer/maintainer-entry-profile.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] docs: maintainer: Fix capitalization
Posted by Thorsten Blum 2 weeks, 2 days ago
The sentence starts at the previous line: s/Indicate/indicate/

Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev>
---
 Documentation/maintainer/maintainer-entry-profile.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/maintainer/maintainer-entry-profile.rst b/Documentation/maintainer/maintainer-entry-profile.rst
index cda5d691e967..f411a0d10fad 100644
--- a/Documentation/maintainer/maintainer-entry-profile.rst
+++ b/Documentation/maintainer/maintainer-entry-profile.rst
@@ -68,7 +68,7 @@ wait for the next -rc. At a minimum:
   submissions should appear before -rc5.
 
 - Last -rc to merge features: Deadline for merge decisions
-  Indicate to contributors the point at which an as yet un-applied patch
+  indicate to contributors the point at which an as yet un-applied patch
   set will need to wait for the NEXT+1 merge window. Of course there is no
   obligation to ever accept any given patchset, but if the review has not
   concluded by this point the expectation is the contributor should wait and
-- 
2.51.0
Re: [PATCH] docs: maintainer: Fix capitalization
Posted by Randy Dunlap 2 weeks, 2 days ago
Hi,

On 9/15/25 12:22 PM, Thorsten Blum wrote:
> The sentence starts at the previous line: s/Indicate/indicate/

Are you sure?
ISTM that the entire line is a "sub-heading".

> 
> Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev>
> ---
>  Documentation/maintainer/maintainer-entry-profile.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/maintainer/maintainer-entry-profile.rst b/Documentation/maintainer/maintainer-entry-profile.rst
> index cda5d691e967..f411a0d10fad 100644
> --- a/Documentation/maintainer/maintainer-entry-profile.rst
> +++ b/Documentation/maintainer/maintainer-entry-profile.rst
> @@ -68,7 +68,7 @@ wait for the next -rc. At a minimum:
>    submissions should appear before -rc5.
>  
>  - Last -rc to merge features: Deadline for merge decisions
> -  Indicate to contributors the point at which an as yet un-applied patch
> +  indicate to contributors the point at which an as yet un-applied patch
>    set will need to wait for the NEXT+1 merge window. Of course there is no
>    obligation to ever accept any given patchset, but if the review has not
>    concluded by this point the expectation is the contributor should wait and

-- 
~Randy
Re: [PATCH] docs: maintainer: Fix capitalization
Posted by Thorsten Blum 2 weeks, 2 days ago
Hi Randy,

On 15. Sep 2025, at 21:29, Randy Dunlap wrote:
> On 9/15/25 12:22 PM, Thorsten Blum wrote:
>> The sentence starts at the previous line: s/Indicate/indicate/
> 
> Are you sure?
> ISTM that the entire line is a "sub-heading".

Hm maybe, but then the layout/rendering on the web is very confusing:

https://docs.kernel.org/maintainer/maintainer-entry-profile.html#key-cycle-dates

How would that be fixed?

Thanks,
Thorsten
Re: [PATCH] docs: maintainer: Fix capitalization
Posted by Randy Dunlap 2 weeks, 2 days ago

On 9/15/25 12:35 PM, Thorsten Blum wrote:
> Hi Randy,
> 
> On 15. Sep 2025, at 21:29, Randy Dunlap wrote:
>> On 9/15/25 12:22 PM, Thorsten Blum wrote:
>>> The sentence starts at the previous line: s/Indicate/indicate/
>>
>> Are you sure?
>> ISTM that the entire line is a "sub-heading".

After I sent this I saw that I should have added that it's ambiguous
and needs some formatting help, so I'm not surprised to see this:

> Hm maybe, but then the layout/rendering on the web is very confusing:
> 
> https://docs.kernel.org/maintainer/maintainer-entry-profile.html#key-cycle-dates
> 
> How would that be fixed?
I'm not sure. At a minimum, add another colon at the end of the line.
Or both sub-headings (this one and the one before it) might need a "::"
at the end of the line and then a blank line inserted there.

I'd have to play around with it and test some, but for now I have to do
something else...

-- 
~Randy
Re: [PATCH] docs: maintainer: Fix capitalization
Posted by Thorsten Blum 2 weeks, 2 days ago
On 15. Sep 2025, at 21:43, Randy Dunlap wrote:
> On 9/15/25 12:35 PM, Thorsten Blum wrote:
>> 
>> On 15. Sep 2025, at 21:29, Randy Dunlap wrote:
>>> On 9/15/25 12:22 PM, Thorsten Blum wrote:
>>>> The sentence starts at the previous line: s/Indicate/indicate/
>>> 
>>> Are you sure?
>>> ISTM that the entire line is a "sub-heading".
> 
> After I sent this I saw that I should have added that it's ambiguous
> and needs some formatting help, so I'm not surprised to see this:
> 
>> Hm maybe, but then the layout/rendering on the web is very confusing:
>> 
>> https://docs.kernel.org/maintainer/maintainer-entry-profile.html#key-cycle-dates

I think the entire line is meant to be a sub-heading. If it were a
single sentence, it should be either "Deadline ... indicates" or
"Deadlines ... indicate", but not "Deadline ... indicate".

Maybe the author of 4699c504e603 (cc Dan Williams) can confirm this?

Thanks,
Thorsten
Re: [PATCH] docs: maintainer: Fix capitalization
Posted by Randy Dunlap 2 weeks, 2 days ago

On 9/15/25 1:06 PM, Thorsten Blum wrote:
> On 15. Sep 2025, at 21:43, Randy Dunlap wrote:
>> On 9/15/25 12:35 PM, Thorsten Blum wrote:
>>>
>>> On 15. Sep 2025, at 21:29, Randy Dunlap wrote:
>>>> On 9/15/25 12:22 PM, Thorsten Blum wrote:
>>>>> The sentence starts at the previous line: s/Indicate/indicate/
>>>>
>>>> Are you sure?
>>>> ISTM that the entire line is a "sub-heading".
>>
>> After I sent this I saw that I should have added that it's ambiguous
>> and needs some formatting help, so I'm not surprised to see this:
>>
>>> Hm maybe, but then the layout/rendering on the web is very confusing:
>>>
>>> https://docs.kernel.org/maintainer/maintainer-entry-profile.html#key-cycle-dates
> 
> I think the entire line is meant to be a sub-heading. If it were a
> single sentence, it should be either "Deadline ... indicates" or
> "Deadlines ... indicate", but not "Deadline ... indicate".
> 
> Maybe the author of 4699c504e603 (cc Dan Williams) can confirm this?

I think all that is needed is a blank line after each of these sub-headings.
That makes the html output readable and more understandable.
Would you submit that patch, Thorsten?

thanks.
-- 
~Randy