[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 18/29] qapi/migration.json: Replace _this_ with *this*
From: |
Peter Maydell |
Subject: |
Re: [PATCH 18/29] qapi/migration.json: Replace _this_ with *this* |
Date: |
Fri, 7 Feb 2020 17:00:07 +0000 |
On Fri, 7 Feb 2020 at 16:54, Markus Armbruster <address@hidden> wrote:
>
> Peter Maydell <address@hidden> writes:
>
> > The MigrationInfo::setup-time documentation is the only place where
> > we use _this_ inline markup to mean italics.
>
> Nitpick: _this_ does not mean italics, it means emphasis. See
> qapi-code-gen.txt section "Documentation markup". doc.py maps it to
> @emph{this}, which Texinfo commonly renders in italics when the output
> format supports that.
Yeah, I know. But to my mind nobody actually cares about "is this
'emphasis' or 'strong'", because those are pretty meaningless
and are not very easy to distinguish semantically. What people
actually care about is "how does this render", because bold and
italics look noticeably different and if you're writing you
might care about which you get. At that point 'strong' is just
a confusing synonym for 'bold' and 'emphasis' is a confusing
synonym for 'italics'. But maybe I'm out on a limb here.
Anyway, I'm happy to tweak the commit message.
thanks
-- PMM
- [PATCH 12/29] qapi: Explicitly put "foo: dropped in n.n" notes into Notes section, (continued)
- [PATCH 12/29] qapi: Explicitly put "foo: dropped in n.n" notes into Notes section, Peter Maydell, 2020/02/06
- [PATCH 10/29] qapi: Remove hardcoded tabs, Peter Maydell, 2020/02/06
- [PATCH 15/29] qapi/ui.json: Use explicit bulleted lists, Peter Maydell, 2020/02/06
- [PATCH 17/29] qapi: Add blank lines before bulleted lists, Peter Maydell, 2020/02/06
- [PATCH 18/29] qapi/migration.json: Replace _this_ with *this*, Peter Maydell, 2020/02/06
- [PATCH 20/29] qapi/machine.json: Escape a literal '*' in doc comment, Peter Maydell, 2020/02/06
- [PATCH 21/29] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/02/06
- [PATCH 14/29] qapi/block-core.json: Use explicit bulleted lists, Peter Maydell, 2020/02/06
- [PATCH 16/29] qapi/{block, misc, tmp}.json: Use explicit bulleted lists, Peter Maydell, 2020/02/06
- [PATCH 19/29] qapi/qapi-schema.json: Put headers in their own doc-comment blocks, Peter Maydell, 2020/02/06