From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org, qemu-block@nongnu.org
Cc: armbru@redhat.com, eblake@redhat.com,
Eduardo Habkost <ehabkost@redhat.com>,
Max Reitz <mreitz@redhat.com>, Kevin Wolf <kwolf@redhat.com>,
Cleber Rosa <crosa@redhat.com>, John Snow <jsnow@redhat.com>
Subject: [Qemu-devel] [PATCH RFC 0/3] qemu-img: remove command documentation duplication
Date: Tue, 9 Apr 2019 21:24:10 -0400 [thread overview]
Message-ID: <20190410012413.31569-1-jsnow@redhat.com> (raw)
This might hopefully cut down on the doc duplication/mismatching
until I can devise something more comprehensive.
Ideally, I'd like to redo all of the documentation for qemu-img
nearly from scratch; with a parser generator that helps generate
the documentation as well so they'll never get out of date.
That's probably quite a ways off, and maybe there are other
structural changes we want to make with respect to sphinx and
other build tools, so I am sending something very minimal instead.
This ought to be functionally identical down to the last char.
(I've re-included patch one which I have sent to the list separately,
purely as a dependency if you want to apply these patches.)
John Snow (3):
qemu-img: fix .hx and .texi disparity
pxtool: Add new qemu-img command info generation tool
qemu-img.texi: use macros for command summaries
qemu-img.texi | 28 ++++----
Makefile | 8 +--
qemu-img-cmds.json | 165 +++++++++++++++++++++++++++++++++++++++++++++
qemu-img-cmds.hx | 102 ----------------------------
scripts/pxtool.py | 53 +++++++++++++++
5 files changed, 236 insertions(+), 120 deletions(-)
create mode 100644 qemu-img-cmds.json
delete mode 100644 qemu-img-cmds.hx
create mode 100755 scripts/pxtool.py
--
2.17.2
WARNING: multiple messages have this Message-ID (diff)
From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org, qemu-block@nongnu.org
Cc: Kevin Wolf <kwolf@redhat.com>,
Eduardo Habkost <ehabkost@redhat.com>,
John Snow <jsnow@redhat.com>,
armbru@redhat.com, Max Reitz <mreitz@redhat.com>,
Cleber Rosa <crosa@redhat.com>
Subject: [Qemu-devel] [PATCH RFC 0/3] qemu-img: remove command documentation duplication
Date: Tue, 9 Apr 2019 21:24:10 -0400 [thread overview]
Message-ID: <20190410012413.31569-1-jsnow@redhat.com> (raw)
Message-ID: <20190410012410.NY2f-V4EAJkyoLZtpLiJaWqh8de7MzLGa4g2pS955Jk@z> (raw)
This might hopefully cut down on the doc duplication/mismatching
until I can devise something more comprehensive.
Ideally, I'd like to redo all of the documentation for qemu-img
nearly from scratch; with a parser generator that helps generate
the documentation as well so they'll never get out of date.
That's probably quite a ways off, and maybe there are other
structural changes we want to make with respect to sphinx and
other build tools, so I am sending something very minimal instead.
This ought to be functionally identical down to the last char.
(I've re-included patch one which I have sent to the list separately,
purely as a dependency if you want to apply these patches.)
John Snow (3):
qemu-img: fix .hx and .texi disparity
pxtool: Add new qemu-img command info generation tool
qemu-img.texi: use macros for command summaries
qemu-img.texi | 28 ++++----
Makefile | 8 +--
qemu-img-cmds.json | 165 +++++++++++++++++++++++++++++++++++++++++++++
qemu-img-cmds.hx | 102 ----------------------------
scripts/pxtool.py | 53 +++++++++++++++
5 files changed, 236 insertions(+), 120 deletions(-)
create mode 100644 qemu-img-cmds.json
delete mode 100644 qemu-img-cmds.hx
create mode 100755 scripts/pxtool.py
--
2.17.2
next reply other threads:[~2019-04-10 1:24 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-10 1:24 John Snow [this message]
2019-04-10 1:24 ` [Qemu-devel] [PATCH RFC 0/3] qemu-img: remove command documentation duplication John Snow
2019-04-10 1:24 ` [Qemu-devel] [PATCH RFC 1/3] qemu-img: fix .hx and .texi disparity John Snow
2019-04-10 1:24 ` John Snow
2019-04-10 1:24 ` [Qemu-devel] [PATCH RFC 2/3] pxtool: Add new qemu-img command info generation tool John Snow
2019-04-10 1:24 ` John Snow
2019-04-10 5:54 ` Markus Armbruster
2019-04-10 5:54 ` Markus Armbruster
2019-04-10 17:55 ` John Snow
2019-04-10 17:55 ` John Snow
2019-04-11 6:22 ` Markus Armbruster
2019-04-11 6:22 ` Markus Armbruster
2019-04-11 20:02 ` John Snow
2019-04-11 20:02 ` John Snow
2019-04-12 8:04 ` Markus Armbruster
2019-04-12 8:04 ` Markus Armbruster
2019-04-10 1:24 ` [Qemu-devel] [PATCH RFC 3/3] qemu-img.texi: use macros for command summaries John Snow
2019-04-10 1:24 ` John Snow
2019-06-26 18:03 ` [Qemu-devel] [PATCH RFC 0/3] qemu-img: remove command documentation duplication Max Reitz
2019-06-26 18:07 ` John Snow
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=20190410012413.31569-1-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=armbru@redhat.com \
--cc=crosa@redhat.com \
--cc=eblake@redhat.com \
--cc=ehabkost@redhat.com \
--cc=kwolf@redhat.com \
--cc=mreitz@redhat.com \
--cc=qemu-block@nongnu.org \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).