diff mbox series

[v2] process/release-technician-checklist: Explain how the banner in README is generated

Message ID 20221124190850.35344-1-julien@xen.org (mailing list archive)
State New, archived
Headers show
Series [v2] process/release-technician-checklist: Explain how the banner in README is generated | expand

Commit Message

Julien Grall Nov. 24, 2022, 7:08 p.m. UTC
From: Julien Grall <jgrall@amazon.com>

Explain how the banner in README is generated and take the opportunity
to mention what it should look like for RC.

Signed-off-by: Julien Grall <jgrall@amazon.com>

----
    Changes in v2:
        - Mention what the banner looks like for RC.
---
 docs/process/release-technician-checklist.txt | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

Comments

Jan Beulich Nov. 25, 2022, 9:17 a.m. UTC | #1
On 24.11.2022 20:08, Julien Grall wrote:
> From: Julien Grall <jgrall@amazon.com>
> 
> Explain how the banner in README is generated and take the opportunity
> to mention what it should look like for RC.
> 
> Signed-off-by: Julien Grall <jgrall@amazon.com>

Acked-by: Jan Beulich <jbeulich@suse.com>
albeit with a couple of nits:

> --- a/docs/process/release-technician-checklist.txt
> +++ b/docs/process/release-technician-checklist.txt
> @@ -48,7 +48,12 @@ t=RELEASE-$r
>  
>  * consider bumping sonames of shlibs
>  
> -* change xen-unstable README (should say "Xen 4.5" in releases and on stable branches, "Xen 4.5-unstable" on unstable)
> +* change xen-unstable README. Should say:
> +    - "Xen 4.5" in releases and on stable branches
> +    - "Xen 4.5-unstable" on unstable
> +    - "Xen 4.5-rc" for release candidate
> +
> +*   The banner is generated using figlet
>  * change xen-unstable Config.mk

Perhaps insert another blank line between these two bullet points?
Or, if they're deemed to belong together, remove the one you insert?

The new bullet point you add also would likely want to match the
others in style, both for the number of spaces after * and for not
using a capital first letter (maybe "generate banner using figlet").

Jan
Henry Wang Dec. 1, 2022, 10:50 a.m. UTC | #2
Hi, 

> -----Original Message-----
> Subject: Re: [PATCH v2] process/release-technician-checklist: Explain how the
> banner in README is generated
> 
> On 24.11.2022 20:08, Julien Grall wrote:
> > From: Julien Grall <jgrall@amazon.com>
> >
> > Explain how the banner in README is generated and take the opportunity
> > to mention what it should look like for RC.
> >
> > Signed-off-by: Julien Grall <jgrall@amazon.com>
> 
> Acked-by: Jan Beulich <jbeulich@suse.com>

Release-acked-by: Henry Wang <Henry.Wang@arm.com>

With probably Jan's comment in ...

> albeit with a couple of nits:
> 
> > --- a/docs/process/release-technician-checklist.txt
> > +++ b/docs/process/release-technician-checklist.txt
> > @@ -48,7 +48,12 @@ t=RELEASE-$r
> >
> >  * consider bumping sonames of shlibs
> >
> > -* change xen-unstable README (should say "Xen 4.5" in releases and on
> stable branches, "Xen 4.5-unstable" on unstable)
> > +* change xen-unstable README. Should say:
> > +    - "Xen 4.5" in releases and on stable branches
> > +    - "Xen 4.5-unstable" on unstable
> > +    - "Xen 4.5-rc" for release candidate
> > +
> > +*   The banner is generated using figlet
> >  * change xen-unstable Config.mk
> 
> Perhaps insert another blank line between these two bullet points?
> Or, if they're deemed to belong together, remove the one you insert?
> 
> The new bullet point you add also would likely want to match the
> others in style, both for the number of spaces after * and for not
> using a capital first letter (maybe "generate banner using figlet").

..here addressed (can be fix on commit).

Kind regards,
Henry


> 
> Jan
Julien Grall Dec. 5, 2022, 11:16 a.m. UTC | #3
Hi Jan,

On 25/11/2022 09:17, Jan Beulich wrote:
> On 24.11.2022 20:08, Julien Grall wrote:
>> From: Julien Grall <jgrall@amazon.com>
>>
>> Explain how the banner in README is generated and take the opportunity
>> to mention what it should look like for RC.
>>
>> Signed-off-by: Julien Grall <jgrall@amazon.com>
> 
> Acked-by: Jan Beulich <jbeulich@suse.com>
> albeit with a couple of nits:
> 
>> --- a/docs/process/release-technician-checklist.txt
>> +++ b/docs/process/release-technician-checklist.txt
>> @@ -48,7 +48,12 @@ t=RELEASE-$r
>>   
>>   * consider bumping sonames of shlibs
>>   
>> -* change xen-unstable README (should say "Xen 4.5" in releases and on stable branches, "Xen 4.5-unstable" on unstable)
>> +* change xen-unstable README. Should say:
>> +    - "Xen 4.5" in releases and on stable branches
>> +    - "Xen 4.5-unstable" on unstable
>> +    - "Xen 4.5-rc" for release candidate
>> +
>> +*   The banner is generated using figlet
>>   * change xen-unstable Config.mk
> 
> Perhaps insert another blank line between these two bullet points?
> Or, if they're deemed to belong together, remove the one you insert?

I will add another blank line.

> 
> The new bullet point you add also would likely want to match the
> others in style, both for the number of spaces after * and for not
> using a capital first letter (maybe "generate banner using figlet").

Sure. I will address them before committing.

Cheers,
Julien Grall Dec. 5, 2022, 11:19 a.m. UTC | #4
On 05/12/2022 11:16, Julien Grall wrote:
> Hi Jan,
> 
> On 25/11/2022 09:17, Jan Beulich wrote:
>> On 24.11.2022 20:08, Julien Grall wrote:
>>> From: Julien Grall <jgrall@amazon.com>
>>>
>>> Explain how the banner in README is generated and take the opportunity
>>> to mention what it should look like for RC.
>>>
>>> Signed-off-by: Julien Grall <jgrall@amazon.com>
>>
>> Acked-by: Jan Beulich <jbeulich@suse.com>
>> albeit with a couple of nits:
>>
>>> --- a/docs/process/release-technician-checklist.txt
>>> +++ b/docs/process/release-technician-checklist.txt
>>> @@ -48,7 +48,12 @@ t=RELEASE-$r
>>>   * consider bumping sonames of shlibs
>>> -* change xen-unstable README (should say "Xen 4.5" in releases and 
>>> on stable branches, "Xen 4.5-unstable" on unstable)
>>> +* change xen-unstable README. Should say:
>>> +    - "Xen 4.5" in releases and on stable branches
>>> +    - "Xen 4.5-unstable" on unstable
>>> +    - "Xen 4.5-rc" for release candidate
>>> +
>>> +*   The banner is generated using figlet
>>>   * change xen-unstable Config.mk
>>
>> Perhaps insert another blank line between these two bullet points?
>> Or, if they're deemed to belong together, remove the one you insert?
> 
> I will add another blank line.
> 
>>
>> The new bullet point you add also would likely want to match the
>> others in style, both for the number of spaces after * and for not
>> using a capital first letter (maybe "generate banner using figlet").
> 
> Sure. I will address them before committing.

I had another look and went with the following:

+* change xen-unstable README. The banner (generated using figlet) 
should say:
+    - "Xen 4.5" in releases and on stable branches
+    - "Xen 4.5-unstable" on unstable
+    - "Xen 4.5-rc" for release candidate
+

So only one bullet point and using () to explain how the banner is 
generated.

Cheers,
Julien Grall Dec. 5, 2022, 11:22 a.m. UTC | #5
On 01/12/2022 10:50, Henry Wang wrote:
> Hi,

Hi Henry,

>> -----Original Message-----
>> Subject: Re: [PATCH v2] process/release-technician-checklist: Explain how the
>> banner in README is generated
>>
>> On 24.11.2022 20:08, Julien Grall wrote:
>>> From: Julien Grall <jgrall@amazon.com>
>>>
>>> Explain how the banner in README is generated and take the opportunity
>>> to mention what it should look like for RC.
>>>
>>> Signed-off-by: Julien Grall <jgrall@amazon.com>
>>
>> Acked-by: Jan Beulich <jbeulich@suse.com>
> 
> Release-acked-by: Henry Wang <Henry.Wang@arm.com>

Thanks for the release-acked-by. However, I have no plan to port this 
patch to 4.17 (IMHO, a release technician should always read the 
unstable checklist).

Cheers,
Henry Wang Dec. 5, 2022, 11:28 a.m. UTC | #6
Hi Julien,

> -----Original Message-----
> From: Julien Grall <julien@xen.org>
> Subject: Re: [PATCH v2] process/release-technician-checklist: Explain how the
> banner in README is generated
> >> Acked-by: Jan Beulich <jbeulich@suse.com>
> >
> > Release-acked-by: Henry Wang <Henry.Wang@arm.com>
> 
> Thanks for the release-acked-by. However, I have no plan to port this
> patch to 4.17 (IMHO, a release technician should always read the
> unstable checklist).

No problem. Sorry for the noise :)

Speaking of the checklist and maybe it is slightly off topic: Will it bother
you or other maintainers if I send a patch to remove the "qemu-iwj"
section in the branch list? According to the discussion with Ian [1], I think
this can be safely dropped, and I am asking because I think this indeed
causes some confusion in the 4.17 branching process.

[1] https://lore.kernel.org/xen-devel/25482.10006.140155.984629@chiark.greenend.org.uk/

Kind regards,
Henry

> 
> Cheers,
> 
> --
> Julien Grall
Julien Grall Dec. 5, 2022, 11:45 a.m. UTC | #7
On 05/12/2022 11:28, Henry Wang wrote:
> Hi Julien,

Hi Henry,

> 
>> -----Original Message-----
>> From: Julien Grall <julien@xen.org>
>> Subject: Re: [PATCH v2] process/release-technician-checklist: Explain how the
>> banner in README is generated
>>>> Acked-by: Jan Beulich <jbeulich@suse.com>
>>>
>>> Release-acked-by: Henry Wang <Henry.Wang@arm.com>
>>
>> Thanks for the release-acked-by. However, I have no plan to port this
>> patch to 4.17 (IMHO, a release technician should always read the
>> unstable checklist).
> 
> No problem. Sorry for the noise :)
> 
> Speaking of the checklist and maybe it is slightly off topic: Will it bother
> you or other maintainers if I send a patch to remove the "qemu-iwj"
> section in the branch list? According to the discussion with Ian [1], I think
> this can be safely dropped, and I am asking because I think this indeed
> causes some confusion in the 4.17 branching process.
There are a few bits in the branch checklist that needs to be updated. 
This include removing the section "qemu-iwj.git". I will aim to send the 
series this week.

Cheers,
Henry Wang Dec. 5, 2022, 11:47 a.m. UTC | #8
Hi Julien,

> > Speaking of the checklist and maybe it is slightly off topic: Will it bother
> > you or other maintainers if I send a patch to remove the "qemu-iwj"
> > section in the branch list? According to the discussion with Ian [1], I think
> > this can be safely dropped, and I am asking because I think this indeed
> > causes some confusion in the 4.17 branching process.
> There are a few bits in the branch checklist that needs to be updated.
> This include removing the section "qemu-iwj.git". I will aim to send the
> series this week.

Cool. Thanks for your time :)

Kind regards,
Henry

> 
> Cheers,
> 
> --
> Julien Grall
diff mbox series

Patch

diff --git a/docs/process/release-technician-checklist.txt b/docs/process/release-technician-checklist.txt
index 7515da202c92..5031d1bd2288 100644
--- a/docs/process/release-technician-checklist.txt
+++ b/docs/process/release-technician-checklist.txt
@@ -48,7 +48,12 @@  t=RELEASE-$r
 
 * consider bumping sonames of shlibs
 
-* change xen-unstable README (should say "Xen 4.5" in releases and on stable branches, "Xen 4.5-unstable" on unstable)
+* change xen-unstable README. Should say:
+    - "Xen 4.5" in releases and on stable branches
+    - "Xen 4.5-unstable" on unstable
+    - "Xen 4.5-rc" for release candidate
+
+*   The banner is generated using figlet
 * change xen-unstable Config.mk
 #   QEMU_UPSTREAM_REVISION,
 #   QEMU_TRADITIONAL_REVISION