From: Markus Armbruster <armbru@redhat.com>
To: "Daniel P. Berrangé" <berrange@redhat.com>
Cc: Eduardo Habkost <ehabkost@redhat.com>,
Eric Blake <eblake@redhat.com>,
qemu-devel@nongnu.org,
"Dr. David Alan Gilbert" <dgilbert@redhat.com>
Subject: Re: [PATCH 1/5] docs/devel: document expectations for QAPI data modelling for QMP
Date: Fri, 10 Sep 2021 15:45:11 +0200 [thread overview]
Message-ID: <87sfyca6jc.fsf@dusky.pond.sub.org> (raw)
In-Reply-To: <YTtTwwXjG9/u653o@redhat.com> ("Daniel P. Berrangé"'s message of "Fri, 10 Sep 2021 13:46:59 +0100")
Daniel P. Berrangé <berrange@redhat.com> writes:
> On Thu, Sep 09, 2021 at 11:33:20AM +0200, Markus Armbruster wrote:
[...]
>> There are many existing long lines in this file, so I'm not flagging
>> yours, except for this one, because it increases the maximum.
>
> This line is at exactly 80 characters so checkstyle is happy with it.
> We don't have any requirement for a differenet line limit for docs
> afair ?
We don't. I'm asking for a favour.
Humans tend to have trouble following long lines with our eyes (I sure
do). Typographic manuals suggest to limit columns to roughly 60
characters for exactly that reason[1].
70 is a reasonable compromise between legibility and "writability". For
code, we use 80-90, because there the actual width should still be fine
due to indentation.
checkpatch.pl doesn't differentiate betwen code and prose.
This file is already hard to read for me. Please consider not making it
harder.
[1] https://en.wikipedia.org/wiki/Column_(typography)#Typographic_style
next prev parent reply other threads:[~2021-09-10 13:46 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-08 10:37 [PATCH 0/5] Stop adding HMP-only commands, allow QMP for all Daniel P. Berrangé
2021-09-08 10:37 ` [PATCH 1/5] docs/devel: document expectations for QAPI data modelling for QMP Daniel P. Berrangé
2021-09-08 17:42 ` Eric Blake
2021-09-09 9:33 ` Markus Armbruster
2021-09-10 12:46 ` Daniel P. Berrangé
2021-09-10 13:45 ` Markus Armbruster [this message]
2021-09-10 13:52 ` Daniel P. Berrangé
2021-09-08 10:37 ` [PATCH 2/5] hw/core: introduce 'format_state' callback to replace 'dump_state' Daniel P. Berrangé
2021-09-08 10:37 ` [PATCH 3/5] target/i386: convert to use format_state instead of dump_state Daniel P. Berrangé
2021-09-08 12:17 ` Ján Tomko
2021-09-08 18:05 ` Eric Blake
2021-09-08 22:06 ` Daniel P. Berrangé
2021-09-09 9:55 ` Daniel P. Berrangé
2021-09-08 10:37 ` [PATCH 4/5] qapi: introduce x-query-registers QMP command Daniel P. Berrangé
2021-09-08 18:06 ` Eric Blake
2021-09-09 9:05 ` Markus Armbruster
2021-09-09 10:01 ` Daniel P. Berrangé
2021-09-08 10:37 ` [PATCH 5/5] monitor: rewrite 'info registers' in terms of 'x-query-registers' Daniel P. Berrangé
2021-09-08 11:01 ` Philippe Mathieu-Daudé
2021-09-08 11:02 ` Daniel P. Berrangé
2021-09-08 12:18 ` [PATCH 0/5] Stop adding HMP-only commands, allow QMP for all Ján Tomko
2021-09-08 15:09 ` Markus Armbruster
2021-09-08 15:24 ` Daniel P. Berrangé
2021-09-09 4:48 ` Markus Armbruster
2021-09-09 8:13 ` Markus Armbruster
2021-09-09 8:40 ` Daniel P. Berrangé
2021-09-08 16:15 ` Philippe Mathieu-Daudé
2021-09-09 6:15 ` Paolo Bonzini
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=87sfyca6jc.fsf@dusky.pond.sub.org \
--to=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=dgilbert@redhat.com \
--cc=eblake@redhat.com \
--cc=ehabkost@redhat.com \
--cc=qemu-devel@nongnu.org \
/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.