[v1] docs/process: branching-checklist: Update it

[PATCH 5/8] docs/process: branching-checklist: Reword the section about Config.mk

Posted by Julien Grall 3 years, 1 month ago

From: Julien Grall <jgrall@amazon.com>

Since at least Xen 4.12, the revision for external trees don't contain
the word "unstable". So explicitely list the *_REVISION variables that
need to be updated as part of the branching process.

Signed-off-by: Julien Grall <jgrall@amazon.com>
---
 docs/process/branching-checklist.txt | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

diff --git a/docs/process/branching-checklist.txt b/docs/process/branching-checklist.txt
index d1550385c96e..7004f16e8311 100644
--- a/docs/process/branching-checklist.txt
+++ b/docs/process/branching-checklist.txt
@@ -69,11 +69,9 @@ ov=4.0
     git add versions
     git commit -m "Branch for $v"
 
-Ensure references to qemu trees in xen.git's Config.mk are updated.
-Check this with
-    grep unstable Config.mk
-which should produce no output.  Replace as necessary.
-(There may well be none.)
+Ensure references to qemu trees and Mini-OS in xen.git's Config.mk are updated.
+The variables are QEMU_UPSTREAM_REVISION, QEMU_TRADITIONAL_REVISION and
+MINIOS_UPSTREAM_REVISION.
 
 Update newly diverging staging (unstable) according to
 release-technician-checklist.txt section re README etc.
-- 
2.38.1

Re: [PATCH 5/8] docs/process: branching-checklist: Reword the section about Config.mk

Posted by George Dunlap 3 years, 1 month ago

On Mon, Dec 12, 2022 at 9:34 AM Julien Grall <julien@xen.org> wrote:

> From: Julien Grall <jgrall@amazon.com>
>
> Since at least Xen 4.12, the revision for external trees don't contain
> the word "unstable". So explicitely list the *_REVISION variables that
> need to be updated as part of the branching process.
>
> Signed-off-by: Julien Grall <jgrall@amazon.com>
> ---
>  docs/process/branching-checklist.txt | 8 +++-----
>  1 file changed, 3 insertions(+), 5 deletions(-)
>
> diff --git a/docs/process/branching-checklist.txt
> b/docs/process/branching-checklist.txt
> index d1550385c96e..7004f16e8311 100644
> --- a/docs/process/branching-checklist.txt
> +++ b/docs/process/branching-checklist.txt
> @@ -69,11 +69,9 @@ ov=4.0
>      git add versions
>      git commit -m "Branch for $v"
>
> -Ensure references to qemu trees in xen.git's Config.mk are updated.
> -Check this with
> -    grep unstable Config.mk
> -which should produce no output.  Replace as necessary.
> -(There may well be none.)
> +Ensure references to qemu trees and Mini-OS in xen.git's Config.mk are
> updated.
> +The variables are QEMU_UPSTREAM_REVISION, QEMU_TRADITIONAL_REVISION and
> +MINIOS_UPSTREAM_REVISION.
>

One advantage of the previous wording was that it helped you know what the
references *weren't* supposed to look like (although it might have been
more helpful to know what the references *were* supposed to look like).
Would it make sense to add a few words about what they're supposed to look
like?

 -George

Re: [PATCH 5/8] docs/process: branching-checklist: Reword the section about Config.mk

Posted by Julien Grall 3 years ago

Hi George,

Sorry for the late answer.

On 12/12/2022 12:33, George Dunlap wrote:
> On Mon, Dec 12, 2022 at 9:34 AM Julien Grall <julien@xen.org> wrote:
> 
>> From: Julien Grall <jgrall@amazon.com>
>>
>> Since at least Xen 4.12, the revision for external trees don't contain
>> the word "unstable". So explicitely list the *_REVISION variables that
>> need to be updated as part of the branching process.
>>
>> Signed-off-by: Julien Grall <jgrall@amazon.com>
>> ---
>>   docs/process/branching-checklist.txt | 8 +++-----
>>   1 file changed, 3 insertions(+), 5 deletions(-)
>>
>> diff --git a/docs/process/branching-checklist.txt
>> b/docs/process/branching-checklist.txt
>> index d1550385c96e..7004f16e8311 100644
>> --- a/docs/process/branching-checklist.txt
>> +++ b/docs/process/branching-checklist.txt
>> @@ -69,11 +69,9 @@ ov=4.0
>>       git add versions
>>       git commit -m "Branch for $v"
>>
>> -Ensure references to qemu trees in xen.git's Config.mk are updated.
>> -Check this with
>> -    grep unstable Config.mk
>> -which should produce no output.  Replace as necessary.
>> -(There may well be none.)
>> +Ensure references to qemu trees and Mini-OS in xen.git's Config.mk are
>> updated.
>> +The variables are QEMU_UPSTREAM_REVISION, QEMU_TRADITIONAL_REVISION and
>> +MINIOS_UPSTREAM_REVISION.
>>
> 
> One advantage of the previous wording was that it helped you know what the
> references *weren't* supposed to look like (although it might have been
> more helpful to know what the references *were* supposed to look like).
> Would it make sense to add a few words about what they're supposed to look
> like?

Good point. I will replace the last sentences to:

The variables and there content should be:
   - QEMU_UPSTREAM_REVISION: qemu-xen-X.Y.0
   - QEMU_TRADITIONAL_REVISION: xen-X.Y.0
   - MINIOS_UPSTREAM_REVISION: xen-RELEASE-X.Y.0

Where X.Y is the release version (e.g. 4.17).

Cheers,

-- 
Julien Grall