All of lore.kernel.org
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: "Marc-André Lureau" <marcandre.lureau@gmail.com>
Cc: John Snow <jsnow@redhat.com>, QEMU <qemu-devel@nongnu.org>,
	Stefan Hajnoczi <stefanha@redhat.com>
Subject: Re: [PATCH v4 8/9] qapi: make 'if' condition strings simple identifiers
Date: Fri, 21 May 2021 17:07:51 +0200	[thread overview]
Message-ID: <87mtso15x4.fsf@dusky.pond.sub.org> (raw)
In-Reply-To: <CAJ+F1C+st7399x7RYfW38DjQKWMFWhXq+C+x0QGkZnD23mDofw@mail.gmail.com> (=?utf-8?Q?=22Marc-Andr=C3=A9?= Lureau"'s message of "Fri, 21 May 2021 16:26:12 +0400")

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	other threads:[~2021-05-21 15:09 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-17 16:30 [PATCH v4 0/9] qapi: untie 'if' conditions from C preprocessor marcandre.lureau
2021-05-17 16:30 ` [PATCH v4 1/9] qapi: replace List[str] by QAPISchemaIfCond marcandre.lureau
2021-06-07 14:18   ` Eric Blake
2021-06-08 11:38     ` Marc-André Lureau
2021-05-17 16:30 ` [PATCH v4 2/9] qapi: make gen_if/gen_endif take a simple string marcandre.lureau
2021-05-17 16:30 ` [PATCH v4 3/9] qapi: start building an 'if' predicate tree marcandre.lureau
2021-05-17 16:30 ` [PATCH v4 4/9] qapi: introduce IfPredicateList and IfAny marcandre.lureau
2021-05-17 16:30 ` [PATCH v4 5/9] qapi: add IfNot marcandre.lureau
2021-05-17 16:30 ` [PATCH v4 6/9] qapi: normalize 'if' condition to IfPredicate tree marcandre.lureau
2021-05-17 16:30 ` [PATCH v4 7/9] qapi: convert 'if' C-expressions to the new syntax tree marcandre.lureau
2021-05-17 16:30 ` [PATCH v4 8/9] qapi: make 'if' condition strings simple identifiers marcandre.lureau
2021-05-21 12:02   ` Markus Armbruster
2021-05-21 12:26     ` Marc-André Lureau
2021-05-21 15:07       ` Markus Armbruster [this message]
2021-05-17 16:30 ` [PATCH v4 9/9] docs: update the documentation about schema configuration marcandre.lureau
2021-05-21 11:56   ` Markus Armbruster
2021-05-21 12:29     ` Marc-André Lureau
2021-05-21 15:24 ` [PATCH v4 0/9] qapi: untie 'if' conditions from C preprocessor Markus Armbruster

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87mtso15x4.fsf@dusky.pond.sub.org \
    --to=armbru@redhat.com \
    --cc=jsnow@redhat.com \
    --cc=marcandre.lureau@gmail.com \
    --cc=qemu-devel@nongnu.org \
    --cc=stefanha@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.