qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH v4 8/9] qapi: make 'if' condition strings simple identifiers


From: Markus Armbruster
Subject: Re: [PATCH v4 8/9] qapi: make 'if' condition strings simple identifiers
Date: Fri, 21 May 2021 17:07:51 +0200
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/27.1 (gnu/linux)

Marc-André Lureau <marcandre.lureau@gmail.com> writes:

> On Fri, May 21, 2021 at 4:03 PM Markus Armbruster <armbru@redhat.com> wrote:

[...]

>> At this point in your series, the documentation does not yet reflect the
>> code changes you've made.  You now add another change together with a
>> doc update.  Now the docs match *no* version of the code, past, present,
>> or future.  I find this confusing.  Swap the last two patches?
>>
>> How do you feel about updating documentation before the code?
>>
>
> I thought it would be simpler to update the doc in one go as the last patch
> of this series. But if you prefer intermediary doc update, I can do that.

Updating docs along the way (so it's consistent with the code at all
times) is nice.  But sometimes updating docs just once is easier and
good enough.  Whether to do it first or last is a matter of taste.
First can be nice when it serves specification for the code patches that
follow.

However, what we have here is "none of the above": you update docs last
[PATCH 9], except for one detail, which you update together with the
code in [PATCH 8].

I suggested two possible quick fixes:

1. Swap PATCH 8 and 9.  Now you update docs for PATCH 1-7 last, in PATCH
   8 (formerly 9), and then you update code and docs in PATCH 9
   (formerly 8).

2. Move PATCH 9 to the front.  Now you update docs for PATCH 2-8
   (formerly 1-7) first, in PATCH 1 (formerly 9), and then you update
   both code and docs in PATCH 9 (formerly 8).

If you prefer another way to clean this up, go right ahead!




reply via email to

[Prev in Thread] Current Thread [Next in Thread]