[PATCH v3 00/11] QoL tweaks and github action

[PATCH v3 00/11] QoL tweaks and github action

[Alex Bennée]

Some of these patches I've posted before. Along with general
quality of life tweaks to the build scripts we also introduce a github
workflow to build and publish the current working draft of the spec.

I also fixed a build regression with htlatex which became apparent
when I upgraded to Debian Trixie with a newer htlatex build.

v3
  - make unofficial version clearer
  - tweak the make targets for clarity
  - update commit messages

v2

  - added README.md cleanup
  - applied r-b tags

The following still need review:

  .github: add a runner to build the latest draft
  make-setup-generated: optionally add GIT metadata
  virtio-html.cfg: implement workaround for htlatex regression
  specvars.tex: properly wrap arguments to \urldef
  README.md: convert embedded html to proper MarkDown
  LICENSE.md: convert html to proper MarkDown

Alex.

Alex Bennée (11):
  LICENSE.md: convert html to proper MarkDown
  README.md: convert embedded html to proper MarkDown
  REVISION: update to 1.4-wd01
  .gitpublish: update base to current working branch
  .b4-config: add project defaults
  virtio-html.tex: sort package list
  specvars.tex: properly wrap arguments to \urldef
  virtio-html.cfg: implement workaround for htlatex regression
  make-setup-generated: optionally add GIT metadata
  Makefile: add some simple make automations
  .github: add a runner to build the latest draft

 .b4-config                    |   9 +
 .github/workflows/deploy.yaml |  37 ++++
 .github/workflows/test.yml    |  15 ++
 .gitpublish                   |   2 +-
 LICENSE.md                    |   8 +-
 Makefile                      |  34 +++
 README.md                     | 387 +++++++++++++---------------------
 REVISION                      |   2 +-
 make-setup-generated.sh       |  96 +++++----
 makeall.sh                    |   4 +-
 makehtml.sh                   |   2 +-
 makepdf.sh                    |   2 +-
 specvars.tex                  |  14 +-
 virtio-html.cfg               |   3 +-
 virtio-html.tex               |  30 +--
 15 files changed, 339 insertions(+), 306 deletions(-)
 create mode 100644 .b4-config
 create mode 100644 .github/workflows/deploy.yaml
 create mode 100644 .github/workflows/test.yml
 create mode 100644 Makefile

-- 
2.47.3

[PATCH v3 01/11] LICENSE.md: convert html to proper MarkDown

[Alex Bennée]

There is no point embedding HTML inside the markdown document. It just
makes it messy to edit. The boilerplate text is maintained.

Cc: Robin Cover <robin@oasis-open.org>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
---
 LICENSE.md | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

diff --git a/LICENSE.md b/LICENSE.md
index ef558ec..8078023 100644
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -1,7 +1,5 @@
-<div>
-<h2>License Terms</h2>
+## License Terms
 
-<p>Content in this GitHub code repository has been <a href="https://www.oasis-open.org/policies-guidelines/ipr#def-contribution">contributed</a> by OASIS TC Members, and is governed by the OASIS policies, including the <a href="https://www.oasis-open.org/policies-guidelines/ipr">Intellectual Property Rights (IPR) Policy</a>, the <a href="https://www.oasis-open.org/policies-guidelines/tc-process">Technical Committee (TC) Process</a>, <a href="https://www.oasis-open.org/policies-guidelines/bylaws">Bylaws</a>, and the Technical Committee's choice of <a href="https://www.oasis-open.org/policies-guidelines/ipr#def-ipr-mode">IPR Mode</a> (<i>viz</i>, <a href="https://www.oasis-open.org/policies-guidelines/ipr#Non-Assertion-Mode">Non-Assertion Mode</a>), including any applicable <a href="https://www.oasis-open.org/committees/virtio/ipr.php">declarations</a>. Feedback from non-TC members, if any, is governed by the terms of the <a href="https://www.oasis-open.org/policies-guidelines/ipr#appendixa">OASIS Feedback License</a>.</p>
+Content in this GitHub code repository has been [contributed](https://www.oasis-open.org/policies-guidelines/ipr#def-contribution) by OASIS TC Members, and is governed by the OASIS policies, including the [Intellectual Property Rights (IPR) Policy](https://www.oasis-open.org/policies-guidelines/ipr), the [Technical Committee (TC) Process](https://www.oasis-open.org/policies-guidelines/tc-process), [Bylaws](https://www.oasis-open.org/policies-guidelines/bylaws), and the Technical Committee's choice of [IPR Mode](https://www.oasis-open.org/policies-guidelines/ipr#def-ipr-mode) (_viz_, [Non-Assertion Mode](https://www.oasis-open.org/policies-guidelines/ipr#Non-Assertion-Mode)), including any applicable [declarations](https://www.oasis-open.org/committees/virtio/ipr.php). Feedback from non-TC members, if any, is governed by the terms of the [OASIS Feedback License](https://www.oasis-open.org/policies-guidelines/ipr#appendixa).
 
-<p>Description of this repository is presented in the <a href="https://github.com/oasis-tcs/virtio-spec/blob/master/README.md">README</a> file, and guidelines for contribution/participation are given in the <a href="https://github.com/oasis-tcs/virtio-spec/blob/master/CONTRIBUTING.md">CONTRIBUTING</a> file.</p>
-</div>
+Description of this repository is presented in the [README](https://github.com/oasis-tcs/virtio-spec/blob/master/README.md) file, and guidelines for contribution/participation are given in the [CONTRIBUTING](https://github.com/oasis-tcs/virtio-spec/blob/master/CONTRIBUTING.md) file.
-- 
2.47.3

Re: [PATCH v3 01/11] LICENSE.md: convert html to proper MarkDown

[Manos Pitsidianakis]

On Fri, Oct 10, 2025 at 7:29 PM Alex Bennée <alex.bennee@linaro.org> wrote:
>
> There is no point embedding HTML inside the markdown document. It just
> makes it messy to edit. The boilerplate text is maintained.
>
> Cc: Robin Cover <robin@oasis-open.org>
> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
> ---
>  LICENSE.md | 8 +++-----
>  1 file changed, 3 insertions(+), 5 deletions(-)
>
> diff --git a/LICENSE.md b/LICENSE.md
> index ef558ec..8078023 100644
> --- a/LICENSE.md
> +++ b/LICENSE.md
> @@ -1,7 +1,5 @@
> -<div>
> -<h2>License Terms</h2>
> +## License Terms
>
> -<p>Content in this GitHub code repository has been <a href="https://www.oasis-open.org/policies-guidelines/ipr#def-contribution">contributed</a> by OASIS TC Members, and is governed by the OASIS policies, including the <a href="https://www.oasis-open.org/policies-guidelines/ipr">Intellectual Property Rights (IPR) Policy</a>, the <a href="https://www.oasis-open.org/policies-guidelines/tc-process">Technical Committee (TC) Process</a>, <a href="https://www.oasis-open.org/policies-guidelines/bylaws">Bylaws</a>, and the Technical Committee's choice of <a href="https://www.oasis-open.org/policies-guidelines/ipr#def-ipr-mode">IPR Mode</a> (<i>viz</i>, <a href="https://www.oasis-open.org/policies-guidelines/ipr#Non-Assertion-Mode">Non-Assertion Mode</a>), including any applicable <a href="https://www.oasis-open.org/committees/virtio/ipr.php">declarations</a>. Feedback from non-TC members, if any, is governed by the terms of the <a href="https://www.oasis-open.org/policies-guidelines/ipr#appendixa">OASIS Feedback License</a>.</p>
> +Content in this GitHub code repository has been [contributed](https://www.oasis-open.org/policies-guidelines/ipr#def-contribution) by OASIS TC Members, and is governed by the OASIS policies, including the [Intellectual Property Rights (IPR) Policy](https://www.oasis-open.org/policies-guidelines/ipr), the [Technical Committee (TC) Process](https://www.oasis-open.org/policies-guidelines/tc-process), [Bylaws](https://www.oasis-open.org/policies-guidelines/bylaws), and the Technical Committee's choice of [IPR Mode](https://www.oasis-open.org/policies-guidelines/ipr#def-ipr-mode) (_viz_, [Non-Assertion Mode](https://www.oasis-open.org/policies-guidelines/ipr#Non-Assertion-Mode)), including any applicable [declarations](https://www.oasis-open.org/committees/virtio/ipr.php). Feedback from non-TC members, if any, is governed by the terms of the [OASIS Feedback License](https://www.oasis-open.org/policies-guidelines/ipr#appendixa).
>
> -<p>Description of this repository is presented in the <a href="https://github.com/oasis-tcs/virtio-spec/blob/master/README.md">README</a> file, and guidelines for contribution/participation are given in the <a href="https://github.com/oasis-tcs/virtio-spec/blob/master/CONTRIBUTING.md">CONTRIBUTING</a> file.</p>
> -</div>
> +Description of this repository is presented in the [README](https://github.com/oasis-tcs/virtio-spec/blob/master/README.md) file, and guidelines for contribution/participation are given in the [CONTRIBUTING](https://github.com/oasis-tcs/virtio-spec/blob/master/CONTRIBUTING.md) file.
> --
> 2.47.3
>
>

(Accidentally also replied to the v2 of this patch)

Reviewed-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>

[PATCH v3 02/11] README.md: convert embedded html to proper MarkDown

[Alex Bennée]

There is no point embedding HTML inside the markdown document. It just
makes it messy to edit. The text is unchanged.

While I tried to exactly match the old layout I ended up making some
pragmatic fixes:

  - used # instead of ... in the code blocks
  - added missing - to "To do" sections
  - didn't attempt to block indent the lines notably "OSX users.." and
    the text under "Troubleshooting notes:"

The mailing list emails are also now properly linked for emphasis and
mailto: click-ability.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>

---

GenAI usage: this is a fiddly file to edit by hand even with the full
power of Emacs. However the prompt:

  please rewrite this in github markdown, using ## and ### for
  headings, droping the extraneous <div> and <p> blocks and using
  proper markdown links. Leave the words themselves unchanged.

worked though it like a champ. As the change is mechanical I don't
think there are any copyright concerns so I'm happy to put my s-o-b on
the patch. I'm declaring the usage here because how LLMs can be used
in Open Source project is a live topic of debate.

After the mechanical changes I eyeballed the README on github and
manually tweaked the formatting to match the original layout as
closely as possible.
---
 README.md | 387 +++++++++++++++++++++---------------------------------
 1 file changed, 152 insertions(+), 235 deletions(-)

diff --git a/README.md b/README.md
index 13ab05b..c81a1c1 100644
--- a/README.md
+++ b/README.md
@@ -1,252 +1,169 @@
-<div>
-<h2>README</h2>
+## README
 
-<p>Members of the <a href="https://www.oasis-open.org/committees/virtio/">OASIS Virtual I/O Device (VIRTIO) TC</a> create and manage technical content in this TC GitHub repository ( <a href="https://github.com/oasis-tcs/virtio-spec">https://github.com/oasis-tcs/virtio-spec</a> ) as part of the TC's chartered work (<i>i.e.</i>, the program of work and deliverables described in its <a href="https://www.oasis-open.org/committees/virtio/charter.php">charter</a>).</p>
+Members of the [OASIS Virtual I/O Device (VIRTIO) TC](https://www.oasis-open.org/committees/virtio/) create and manage technical content in this TC GitHub repository ( [https://github.com/oasis-tcs/virtio-spec](https://github.com/oasis-tcs/virtio-spec) ) as part of the TC's chartered work (*i.e.*, the program of work and deliverables described in its [charter](https://www.oasis-open.org/committees/virtio/charter.php)).
 
-<p>OASIS TC GitHub repositories, as described in <a href="https://www.oasis-open.org/resources/tcadmin/github-repositories-for-oasis-tc-members-chartered-work">GitHub Repositories for OASIS TC Members' Chartered Work</a>, are governed by the OASIS <a href="https://www.oasis-open.org/policies-guidelines/tc-process">TC Process</a>, <a href="https://www.oasis-open.org/policies-guidelines/ipr">IPR Policy</a>, and other policies, similar to TC Wikis, TC JIRA issues tracking instances, TC SVN/Subversion repositories, etc.  While they make use of public GitHub repositories, these TC GitHub repositories are distinct from <a href="https://www.oasis-open.org/resources/open-repositories">OASIS Open Repositories</a>, which are used for development of open source <a href="https://www.oasis-open.org/resources/open-repositories/licenses">licensed</a> content.</p>
-</div>
+OASIS TC GitHub repositories, as described in [GitHub Repositories for OASIS TC Members' Chartered Work](https://www.oasis-open.org/resources/tcadmin/github-repositories-for-oasis-tc-members-chartered-work), are governed by the OASIS [TC Process](https://www.oasis-open.org/policies-guidelines/tc-process), [IPR Policy](https://www.oasis-open.org/policies-guidelines/ipr), and other policies, similar to TC Wikis, TC JIRA issues tracking instances, TC SVN/Subversion repositories, etc. While they make use of public GitHub repositories, these TC GitHub repositories are distinct from [OASIS Open Repositories](https://www.oasis-open.org/resources/open-repositories), which are used for development of open source [licensed](https://www.oasis-open.org/resources/open-repositories/licenses) content.
 
-<div>
-<h3>Description</h3>
+### Description
 
-<p>This repository includes the <a href="https://github.com/oasis-tcs/virtio-spec/releases">authoritative source</a> of the VIRTIO (Virtual I/O) Specification document. VIRTIO document describes the specifications of the "virtio" family of devices. These devices are found in virtual environments, yet by design they look like physical devices to the guest within the virtual machine &mdash; and this document treats them as such. This similarity allows the guest to use standard drivers and discovery mechanisms. </p>
+This repository includes the [authoritative source](https://github.com/oasis-tcs/virtio-spec/releases) of the VIRTIO (Virtual I/O) Specification document. VIRTIO document describes the specifications of the "virtio" family of devices. These devices are found in virtual environments, yet by design they look like physical devices to the guest within the virtual machine — and this document treats them as such. This similarity allows the guest to use standard drivers and discovery mechanisms.
 
-<p>The purpose of virtio and this specification is that virtual environments and guests should have a straightforward, efficient, standard and extensible mechanism for virtual devices, rather than boutique per-environment or per-OS mechanisms.</p>
-</div>
+The purpose of virtio and this specification is that virtual environments and guests should have a straightforward, efficient, standard and extensible mechanism for virtual devices, rather than boutique per-environment or per-OS mechanisms.
 
-<div>
-<h3>Contributions</h3>
-<p>As stated in this repository's <a href="https://github.com/oasis-tcs/virtio-spec/blob/master/CONTRIBUTING.md">CONTRIBUTING file</a>, contributors to this repository are expected to be Members of the OASIS virtio TC, for any substantive change requests.  Anyone wishing to contribute to this GitHub project and <a href="https://www.oasis-open.org/join/participation-instructions">participate</a> in the TC's technical activity is invited to join as an OASIS TC Member.  Public feedback is also accepted, subject to the terms of the <a href="https://www.oasis-open.org/policies-guidelines/ipr#appendixa">OASIS Feedback License</a>.</p>
-</div>
+### Contributions
 
+As stated in this repository's [CONTRIBUTING file](https://github.com/oasis-tcs/virtio-spec/blob/master/CONTRIBUTING.md), contributors to this repository are expected to be Members of the OASIS virtio TC, for any substantive change requests. Anyone wishing to contribute to this GitHub project and [participate](https://www.oasis-open.org/join/participation-instructions) in the TC's technical activity is invited to join as an OASIS TC Member. Public feedback is also accepted, subject to the terms of the [OASIS Feedback License](https://www.oasis-open.org/policies-guidelines/ipr#appendixa).
 
+### Licensing
 
-<div>
-<h3>Licensing</h3>
-<p>Please see the <a href="https://github.com/oasis-tcs/virtio-spec/blob/master/LICENSE.md">LICENSE</a> file for description of the license terms and OASIS policies applicable to the TC's work in this GitHub project. Content in this repository is intended to be part of the virtio TC's permanent record of activity, visible and freely available for all to use, subject to applicable OASIS policies, as presented in the repository <a href="https://github.com/oasis-tcs/virtio-spec/blob/master/LICENSE.md">LICENSE</a> file.</p>
-</div>
+Please see the [LICENSE](https://github.com/oasis-tcs/virtio-spec/blob/master/LICENSE.md) file for description of the license terms and OASIS policies applicable to the TC's work in this GitHub project. Content in this repository is intended to be part of the virtio TC's permanent record of activity, visible and freely available for all to use, subject to applicable OASIS policies, as presented in the repository [LICENSE](https://github.os-tcs/virtio-spec/blob/master/LICENSE.md) file.
 
-<div>
+### Further Description of this Repository
 
-<h3>Further Description of this Repository</h3>
-<h4>Building Instructions</h4>
-Authoritative version of the specification is maintained in the
-TeX document format. PDF and HTML versions are made available for
-ease of use and review.
-In order to build the HTML and PDF versions of the spec you will need the
-TeX document production system.
-The easiest way to get it up and running is probably by installing
-<a href="https://www.tug.org/texlive/">Tex-Live</a>.
+#### Building Instructions
 
-<dl>Installation cheat sheet:
-<dt>Fedora:</dt>
-<dd>
-<code>
+Authoritative version of the specification is maintained in the TeX document format. PDF and HTML versions are made available for ease of use and review. In order to build the HTML and PDF versions of the spec you will need the TeX document production system. The easiest way to get it up and running is probably by installing [Tex-Live](https://www.tug.org/texlive/).\
+Installation cheat sheet:
+
+***Fedora:***
+```bash
 sudo dnf install texlive-scheme-full
-</code></dd>
-<dt>
-Ubuntu and other Debian derivatives:
-</dt>
-<dd>
-<code>
+```
+***Ubuntu and other Debian derivatives:***
+```bash
 sudo apt-get install texlive-full
-</code></dd>
-<dt>OSX:<dt>
-<dd>OSX users don't need to install Tex-Live because they already have
-<a href="http://www.tug.org/mactex/">MacTeX</a> installed.
-</dd>
-</dl>
-<dl>The build process generates a ZIP package file including the
-original TeX sources, as well as HTML and PDF formatted
-versions of the specification.
-<dt>To generate the ZIP package, run:<dt>
-<dd>
-<code>
+```
+***OSX:***
+
+OSX users don't need to install Tex-Live because they already have [MacTeX](http://www.tug.org/mactex/) installed.
+
+The build process generates a ZIP package file including the original TeX sources, as well as HTML and PDF formatted versions of the specification.
+
+***To generate the ZIP package, run:***
+```bash
 ./makeall.sh
-</code>
-</dd>
-<dt>Troubleshooting notes:</dt>
-<dd> PDFs of the specification can be generated with
-either MicroSoft's Core fonts for the Web: Arial and Courier New,
-or Liberation fonts: Liberation Sans and Liberation Mono.
-Most systems come with one of these two variants included:
-should you get an error message about missing fonts,
-you will need to downloads and install one of the above
-font packages.
-<dd>
-</dl>
-<h4>Providing Feedback</h4>
-Informal feedback is accepted through the <strong>virtio-comment</strong> mailing list,
-and is archived in <A HREF="https://lore.kernel.org/virtio-comment/">the mailing list archives</A>.
-To provide feedback, subscribe by sending mail to
-<HREF="mailto:virtio-comment+subscribe@lists.linux.dev">virtio-comment+subscribe@lists.linux.dev</A>,
-then after confirming you agree to the IPR sending your feedback to
-<HREF="mailto:virtio-comment@lists.linux.dev">virtio-comment@lists.linux.dev</A>.
-<p>Note that only plain text part of the message is archived, and all
-attachments are stripped. Accordingly, messages sent to the
-mailing list should use text/plain encoding and not
-have any attachments.
-<p>The preferred form of providing feedback is in form of a patch.
-A patch can be generated and sent by cloning the spec repository,
-creating a commit, formatting it as a patch and then sending it.
-For example:
-<code>
-<p>
-git clone https://github.com/oasis-tcs/virtio-spec.git<br>
-... edit spec text, and save ...<br>
-<p>
-git commit -a<br>
-... describe the proposed change, in the following format:<br>
-single line summary<br>
-<br>
-detailed description, including motivation for the change<br>
-<br>
-Signed-off-by: Name &lt;email&gt;<br>
-... then save and close the editor ... <br>
-<p>
-git format-patch -o proposal1/ HEAD~1..<br>
-... generates a new directory proposal1/ and a file starting with 0001- ...<br>
-<p>
+```
+***Troubleshooting notes:***
+  
+PDFs of the specification can be generated with either MicroSoft's Core fonts for the Web: Arial and Courier New, or
+Liberation fonts: Liberation Sans and Liberation Mono. Most systems come with one of these two variants included: should
+you get an error message about missing fonts, you will need to downloads and install one of the above font packages.
+
+#### Providing Feedback
+
+Informal feedback is accepted through the **virtio-comment** mailing list, and is archived in [the mailing list archives](https://lore.kernel.org/virtio-comment/). To provide feedback, subscribe by sending mail to [virtio-comment+subscribe@lists.linux.dev](mailto:virtio-comment+subscribe@lists.linux.dev), then after confirming you agree to the IPR sending your feedback to [virtio-comment@lists.linux.dev](mailto:virtio-comment@lists.linux.dev). Note that only plain text part of the message is archived, and all attachments are stripped. Accordingly, messages sent to the mailing list should use `text/plain` encoding and not have any attachments.
+
+The preferred form of providing feedback is in form of a **patch**. A patch can be generated and sent by cloning the spec repository, creating a commit, formatting it as a patch and then sending it. For example:
+
+```bash
+git clone [https://github.com/oasis-tcs/virtio-spec.git](https://github.com/oasis-tcs/virtio-spec.git)
+# edit spec text, and save ...
+git commit -a
+```
+
+Describe the proposed change, in the following format:
+
+  > single line summary
+  > 
+  > detailed description, including motivation for the change
+  >
+  > Signed-off-by: Name <email>
+
+then save and close the editor
+
+```bash
+git format-patch -o proposal1/ HEAD~1..
+# generates a new directory proposal1/ and a file starting with 0001- ...
 git send-email --to=virtio-comment@lists.linux.dev proposal1/0001-*
-</code>
-
-<dl>Optionally, you can use <a
-href="https://github.com/stefanha/git-publish">git-publish</a> to submit a
-patch. This project already contains a <em>git-publish</em> profile that will
-configure some fields, e.g., <em>To</em> field with the right address. After you have
-installed <em>git-publish</em>, the procedure is the following:
-
-<code>
-<p>
-git checkout master -b my-feature<br>
-# work on new commits, add your 'Signed-off-by' lines to each<br>
-git publish<br>
-# more work, rebase on master, ...<br>
-git publish # will send a v2<br>
-</code>
-</dl>
-<dl>
-<dt>When to use the virtio-comment mailing list:</dt>
-<dd>
-  questions and change proposals for the Virtio specification,
-  including the specification of basic functionality, transports and
-  devices.
-</dd>
-
-<dt>When <em>not</em> to use the virtio-comment mailing list:</dt>
-<dd>
-  questions and change proposals for Virtio drivers and devices
-  implementing the specification.
-  (please use the <A HREF="mailto:virtio-dev@lists.linux.dev"> virtio-dev mailing list</A> for this).
-</dd>
-
-<dt>To do:</dt>
-<dd>
- send email preferably in text format (best for archiving).
-</dd>
-
-<dt>Not to do:</dt>
-<dd>
-<ul>
-<li> copy both virtio-dev and virtio-comment mailing lists (instead, pick one);
-<li> send full copies of the virtio spec (in any format).
-</ul>
-</dd>
-
-</dl>
-<h4>Note for TC Members</h4>
-<p>TC Members should review TC specific
-process rules under "Further Description of this Repository"
-in <A
-HREF="https://github.com/oasis-tcs/virtio-admin">https://github.com/oasis-tcs/virtio-admin</A>.
-
-</div>
-<h4>Implementation discussion</h4>
-Implementation discussion takes place on the <strong>virtio-dev</strong> mailing list,
-and is archived in <A HREF="https://lore.kernel.org/virtio-dev/">the mailing list archives</A>.
-To participate in the discussion, subscribe by sending mail to
-<HREF="mailto:virtio-dev+subscribe@lists.linux.dev">
-virtio-dev+subscribe@lists.linux.dev</A>.
-After agreeing to the IPR, to participate in the discussion, send
-mail to <HREF="mailto:virtio-dev@lists.linux.dev">virtio-dev@lists.linux.dev</A>.
-<p>This is the correct list to copy on Linux virtio UAPI change proposals.
-<p>Note that only the plain text part of the message is archived, and all
-attachments are stripped. Accordingly, messages sent to the
-mailing list should use text/plain encoding and not
-have any attachments.
-
-<dl>
-<dt>When to use the virtio-dev mailing list:</dt>
-<dd>
-  questions and change proposals for Virtio drivers and devices
-  implementing the specification.
-</dd>
-
-<dt>When <em>not</em> to use the virtio-dev mailing list:</dt>
-<dd>
-  questions and change proposals for the Virtio specification,
-  including the specification of basic functionality, transports and
-  devices (please use the <A HREF="mailto:virtio-comment@lists.linux.dev"> virtio-comment mailing list</A> for this).
-</dd>
-<dt>To do:</dt>
-<dd>
- send email preferably in text format (best for archiving).
-</dd>
-
-<dt>Not to do:</dt>
-<dd>
-copy both virtio-dev and virtio-comment mailing lists (instead, pick one).
-</dd>
-</dl>
-
-<h4>Use of github issues</h4>
-Note: according to the virtio TC rules, all official TC communication
-is taking place on one of the TC mailing lists.
-In particular, all comments must be provided on
-one of the TC mailing lists. Accordingly, the TC will not respond
-to comments provided in github issues: github issues are
-used solely to track integration of comments into the
-specification.<p>
+```
+
+Optionally, you can use [git-publish](https://github.com/stefanha/git-publish) to submit a patch. This project already contains a *git-publish* profile that will configure some fields, e.g., *To* field with the right address. After you have installed *git-publish*, the procedure is the following:
+
+```bash
+git checkout master -b my-feature
+# work on new commits, add your 'Signed-off-by' lines to each
+git publish
+# more work, rebase on master, ...
+git publish # will send a v2
+```
+
+***When to use the virtio-comment mailing list:***
+
+questions and change proposals for the Virtio specification, including the specification of basic functionality, transports and devices.
+
+***When not to use the virtio-comment mailing list:***
+
+questions and change proposals for Virtio drivers and devices implementing the specification. (please use the [virtio-dev mailing list](mailto:virtio-dev@lists.linux.dev) for this).
+
+***To do:***
+- send email preferably in text format (best for archiving).
+
+***Not to do:***
+- copy both virtio-dev and virtio-comment mailing lists (instead, pick one);
+- send full copies of the virtio spec (in any format).
+
+#### Note for TC Members
+
+TC Members should review TC specific process rules under "Further Description of this Repository" in [https://github.com/oasis-tcs/virtio-admin](https://github.com/oasis-tcs/virtio-admin)
+
+#### Implementation discussion
+
+Implementation discussion takes place on the **virtio-dev** mailing list, and is archived in [the mailing list archives](https://lore.kernel.org/virtio-dev/). To participate in the discussion, subscribe by sending mail to
+[virtio-dev+subscribe@lists.linux.dev](mailto:virtio-dev+subscribe@lists.linux.dev). After agreeing to the IPR, to participate in the discussion, send mail to [virtio-dev@lists.linux.dev](mailto:virtio-dev@lists.linux.dev). This is the correct list to copy on Linux virtio UAPI change proposals.
+
+Note that only the plain text part of the message is archived, and all attachments are stripped. Accordingly, messages sent to the mailing list should use text/plain encoding and not have any attachments.
+
+***When to use the virtio-dev mailing list:***
+
+questions and change proposals for Virtio drivers and devices implementing the specification.
+
+***When not to use the virtio-dev mailing list:***
+
+questions and change proposals for the Virtio specification, including the specification of basic functionality, transports and devices (please use the [virtio-comment mailing list](mailto:virtio-comment@lists.linux.dev) for this).
+
+***To do:***
+- send email preferably in text format (best for archiving).
+
+***Not to do:***
+- copy both virtio-dev and virtio-comment mailing lists (instead, pick one).
+
+#### Use of github issues
+
+Note: according to the virtio TC rules, all official TC communication is taking place on one of the TC mailing lists. In particular, all comments must be provided on one of the TC mailing lists. Accordingly, the TC will not respond to comments provided in github issues: github issues are used solely to track integration of comments into the specification.\
 To request a TC vote on resolving a specific comment:
-<ol>
-<li>Create a github issue, or edit an existing issue, with
-a short summary of the comment.
-The issue MUST specify
-the link to the latest proposal in the TC mailing list
-archives. <em>Note:</em> the link MUST be in the issue description itself -
-<em>not</em> in the comments.</li>
-<li>Reply by email to the comment email, requesting that the TC vote
-on resolving the issue.
-The mail requesting the vote should include the following, on a line by itself:<br>
-<code>
-Fixes: https://github.com/oasis-tcs/virtio-spec/issues/NNN
-</code>
-(NNN is the issue number)<br>
-For example, you can use the following template when requesting the TC vote:<br>
-<code>
-Could please open a voting ballot for these changes?<br>
-<br>
-Fixes: https://github.com/oasis-tcs/virtio-spec/issues/NNN<br>
-</code></li>
-<li>Please make sure to allow time for review between posting a comment
-and asking for a vote. </li>
-</ol>
-<h4>TC standing rules</h4>
-The TC adopted the following standing rule:
-<p>
-<em>
-Minor cleanups, including editorial formatting changes, spelling
-and typo fixes can be committed directly into git for approval as
-part of the next specification approval ballot.
-</em>
-<ol>
-<li>To request such a commit, reply by email to the comment email, requesting that the
-issue is resolved under the minor cleanups standing rule.
-</li>
-<li>Please make sure to allow time for review between posting a comment
-and asking for a commit. </li>
-</ol>
-
-<h3>Contact</h3>
-<p>Please send questions or comments about <a href="https://www.oasis-open.org/resources/tcadmin/github-repositories-for-oasis-tc-members-chartered-work">OASIS TC GitHub repositories</a> to <a href="mailto:robin@oasis-open.org">Robin Cover</a> and <a href="mailto:chet.ensign@oasis-open.org">Chet Ensign</a>.  For questions about content in this repository, please contact the TC Chair or Co-Chairs as listed on the the virtio TC's <a href="https://www.oasis-open.org/committees/virtio/">home page</a>.</p>
-</div>
+
+1. Create a github issue, or edit an existing issue, with a short summary of the comment.
+   The issue MUST specify the link to the latest proposal in the TC mailing list
+   archives. *Note:* the link MUST be in the issue description itself - *not* in the comments.
+
+2. Reply by email to the comment email, requesting that the TC vote on resolving the issue.
+   The mail requesting the vote should include the following, on a line by itself:
+
+   ```
+   Fixes: https://github.com/oasis-tcs/virtio-spec/issues/NNN
+   ```
+   (NNN is the issue number)
+
+   For example, you can use the following template when requesting the TC vote:
+
+   ```
+   Could please open a voting ballot for these changes?
+
+   Fixes: https://github.com/oasis-tcs/virtio-spec/issues/NNN
+   ```
+
+3. Please make sure to allow time for review between posting a comment and asking for a vote.
+
+#### TC standing rules
+
+The TC adopted the following standing rule:\
+*Minor cleanups, including editorial formatting changes, spelling and typo fixes can be committed directly into git for approval as part of the next specification approval ballot.*
+
+1. To request such a commit, reply by email to the comment email, requesting that the issue is resolved under the minor cleanups standing rule.
+2. Please make sure to allow time for review between posting a comment and asking for a commit.
+
+### Contact
+
+Please send questions or comments about [OASIS TC GitHub repositories](https://www.oasis-open.org/resources/tcadmin/github-repositories-for-oasis-tc-members-chartered-work)
+to [Robin Cover](mailto:robin@oasis-open.org) and [Chet Ensign](mailto:chet.ensign@oasis-open.org). For questions about content in this repository, please contact the TC Chair or Co-Chairs
+as listed on the the virtio TC's [home page](https://www.oasis-open.org/committees/virtio/).
-- 
2.47.3

[PATCH v3 03/11] REVISION: update to 1.4-wd01

[Alex Bennée]

The state of the repo is currently working on the 1.4 specification so
anything we generate should reflect that. It will be updated again on
the official release.

Reviewed-by: Parav Pandit <parav@nvidia.com>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
---
 REVISION | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/REVISION b/REVISION
index ba56baf..e3c043e 100644
--- a/REVISION
+++ b/REVISION
@@ -1 +1 @@
-virtio-v1.3-csd01
+virtio-v1.4-wd01
-- 
2.47.3

[PATCH v3 04/11] .gitpublish: update base to current working branch

[Alex Bennée]

The current working branch is virtio-1.4 so lets use that as our
reference for gitpublish.

Reviewed-by: Parav Pandit <parav@nvidia.com>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
---
 .gitpublish | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.gitpublish b/.gitpublish
index d412896..84414a7 100644
--- a/.gitpublish
+++ b/.gitpublish
@@ -1,3 +1,3 @@
 [gitpublishprofile "default"]
-base = master
+base = origin/virtio-1.4
 to = virtio-comment@lists.linux.dev
-- 
2.47.3

Re: [PATCH v3 04/11] .gitpublish: update base to current working branch

[Stefan Hajnoczi]

[-- Attachment #1: Type: text/plain, Size: 400 bytes --]

On Fri, Oct 10, 2025 at 05:28:51PM +0100, Alex Bennée wrote:
> The current working branch is virtio-1.4 so lets use that as our
> reference for gitpublish.
> 
> Reviewed-by: Parav Pandit <parav@nvidia.com>
> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
> ---
>  .gitpublish | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

[PATCH v3 05/11] .b4-config: add project defaults

[Alex Bennée]

b4 is another tool used to apply and send patches. We might as well
set our project specific settings here.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
---
 .b4-config | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 .b4-config

diff --git a/.b4-config b/.b4-config
new file mode 100644
index 0000000..0ac4110
--- /dev/null
+++ b/.b4-config
@@ -0,0 +1,9 @@
+#
+# Common b4 settings that can be used to send patches to virtio-comment.
+# https://b4.docs.kernel.org/
+#
+
+[b4]
+    send-series-to = virtio-comment@lists.linux.dev
+    searchmask = https://lore.kernel.org/virtio-comment/?x=m&t=1&q=%s
+    linkmask = https://lore.kernel.org/virto-comment/%s
-- 
2.47.3

Re: [PATCH v3 05/11] .b4-config: add project defaults

[Manos Pitsidianakis]

On Fri, Oct 10, 2025 at 7:29 PM Alex Bennée <alex.bennee@linaro.org> wrote:
>
> b4 is another tool used to apply and send patches. We might as well
> set our project specific settings here.
>
> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
> ---
>  .b4-config | 9 +++++++++
>  1 file changed, 9 insertions(+)
>  create mode 100644 .b4-config
>
> diff --git a/.b4-config b/.b4-config
> new file mode 100644
> index 0000000..0ac4110
> --- /dev/null
> +++ b/.b4-config
> @@ -0,0 +1,9 @@
> +#
> +# Common b4 settings that can be used to send patches to virtio-comment.
> +# https://b4.docs.kernel.org/
> +#
> +
> +[b4]
> +    send-series-to = virtio-comment@lists.linux.dev
> +    searchmask = https://lore.kernel.org/virtio-comment/?x=m&t=1&q=%s
> +    linkmask = https://lore.kernel.org/virto-comment/%s
> --
> 2.47.3
>
>

Reviewed-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>

[PATCH v3 06/11] virtio-html.tex: sort package list

[Alex Bennée]

This will make auditing and adding new packages easier.

Reviewed-by: Parav Pandit <parav@nvidia.com>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
---
 virtio-html.tex | 30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/virtio-html.tex b/virtio-html.tex
index 48c633d..a43017a 100644
--- a/virtio-html.tex
+++ b/virtio-html.tex
@@ -5,34 +5,34 @@
 
 \documentclass[10pt,titlepage]{report}
 
-\usepackage{parskip}
-\usepackage{setspace}
+\usepackage[T1]{fontenc}
 \usepackage[english]{babel}
 \usepackage{ae,aecompl} 
-\usepackage[T1]{fontenc}
-\usepackage{graphicx}
+\usepackage{array}
+\usepackage{chngcntr}
+\usepackage{courier}
+\usepackage{enumitem}
+\usepackage{fancyhdr}
+\usepackage{fancyvrb}
 \usepackage{framed}
+\usepackage{graphicx}
 \usepackage{hyperref}
+\usepackage{lastpage}
 \usepackage{lineno} 
 \usepackage{listings}
-\usepackage{courier}
-\usepackage{fancyvrb}
-\usepackage{array}
 \usepackage{longtable}
+\usepackage{mdwlist}
 \usepackage{multirow}
+\usepackage{parskip}
 \usepackage{rotating}
-\usepackage{fancyhdr}
-\usepackage{lastpage}
-\usepackage{xcolor}
+\usepackage{setspace}
+\usepackage{tabularx}
 \usepackage{titlesec}
-\usepackage{mdwlist}
+\usepackage{underscore}
 \usepackage{url}
+\usepackage{xcolor}
 \usepackage{xifthen}
-\usepackage{tabularx}
-\usepackage{underscore}
 \usepackage{xstring}
-\usepackage{enumitem}
-\usepackage{chngcntr}
 \counterwithout{footnote}{chapter}
 
 \usepackage[utf8x]{inputenc}
-- 
2.47.3

[PATCH v3 07/11] specvars.tex: properly wrap arguments to \urldef

[Alex Bennée]

chktex reports:

  Warning 1 in specvars.tex line 6: Command terminated with space.
  \urldef \virtiourllistings\url{\virtiourlbase/listings/}
         ^
  ...

While the space in this case is probably harmless we should be using
non-ambiguous argument wrappers if don't want to drown linter output
with noise.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>

---
v2
  - mention the linter
---
 specvars.tex | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/specvars.tex b/specvars.tex
index a80557a..cf67070 100644
--- a/specvars.tex
+++ b/specvars.tex
@@ -3,13 +3,13 @@
 \newcommand{\virtiospecfile}{virtio-v\virtiorev-\virtiodraftstage\virtioworkingdraft}
 \newcommand{\virtiourlbase}{https://docs.oasis-open.org/virtio/virtio/v\virtiorev/\virtiodraftstage\virtioworkingdraft}
 %Below must be used to make links work correctly in HTML
-\urldef \virtiourllistings\url{\virtiourlbase/listings/}
-\urldef \virtiourltex\url{\virtiourlbase/tex/}
-\urldef \virtiourlpdf\url{\virtiourlbase/\virtiospecfile.pdf}
-\urldef \virtiourlhtml\url{\virtiourlbase/\virtiospecfile.html}
-\urldef \virtiourlh\url{\virtiourlbase/listings/virtio_queue.h}
-\urldef \virtiourllatestpdf\url{https://docs.oasis-open.org/virtio/virtio/v\virtiorev/virtio-v\virtiorev.pdf}
-\urldef \virtiourllatesthtml\url{https://docs.oasis-open.org/virtio/virtio/v\virtiorev/virtio-v\virtiorev.html}
+\urldef{\virtiourllistings}\url{\virtiourlbase/listings/}
+\urldef{\virtiourltex}\url{\virtiourlbase/tex/}
+\urldef{\virtiourlpdf}\url{\virtiourlbase/\virtiospecfile.pdf}
+\urldef{\virtiourlhtml}\url{\virtiourlbase/\virtiospecfile.html}
+\urldef{\virtiourlh}\url{\virtiourlbase/listings/virtio_queue.h}
+\urldef{\virtiourllatestpdf}\url{https://docs.oasis-open.org/virtio/virtio/v\virtiorev/virtio-v\virtiorev.pdf}
+\urldef{\virtiourllatesthtml}\url{https://docs.oasis-open.org/virtio/virtio/v\virtiorev/virtio-v\virtiorev.html}
 \newcommand{\virtioworkproduct}{Standards Track Work Product}
 \newcommand{\virtiooasiscopyright}{Copyright © OASIS Open 2023. All Rights Reserved.}
 
-- 
2.47.3

Re: [PATCH v3 07/11] specvars.tex: properly wrap arguments to \urldef

[Manos Pitsidianakis]

On Fri, Oct 10, 2025 at 7:29 PM Alex Bennée <alex.bennee@linaro.org> wrote:
>
> chktex reports:
>
>   Warning 1 in specvars.tex line 6: Command terminated with space.
>   \urldef \virtiourllistings\url{\virtiourlbase/listings/}
>          ^
>   ...
>
> While the space in this case is probably harmless we should be using
> non-ambiguous argument wrappers if don't want to drown linter output
> with noise.
>
> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
>
> ---
> v2
>   - mention the linter
> ---
>  specvars.tex | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)
>
> diff --git a/specvars.tex b/specvars.tex
> index a80557a..cf67070 100644
> --- a/specvars.tex
> +++ b/specvars.tex
> @@ -3,13 +3,13 @@
>  \newcommand{\virtiospecfile}{virtio-v\virtiorev-\virtiodraftstage\virtioworkingdraft}
>  \newcommand{\virtiourlbase}{https://docs.oasis-open.org/virtio/virtio/v\virtiorev/\virtiodraftstage\virtioworkingdraft}
>  %Below must be used to make links work correctly in HTML
> -\urldef \virtiourllistings\url{\virtiourlbase/listings/}
> -\urldef \virtiourltex\url{\virtiourlbase/tex/}
> -\urldef \virtiourlpdf\url{\virtiourlbase/\virtiospecfile.pdf}
> -\urldef \virtiourlhtml\url{\virtiourlbase/\virtiospecfile.html}
> -\urldef \virtiourlh\url{\virtiourlbase/listings/virtio_queue.h}
> -\urldef \virtiourllatestpdf\url{https://docs.oasis-open.org/virtio/virtio/v\virtiorev/virtio-v\virtiorev.pdf}
> -\urldef \virtiourllatesthtml\url{https://docs.oasis-open.org/virtio/virtio/v\virtiorev/virtio-v\virtiorev.html}
> +\urldef{\virtiourllistings}\url{\virtiourlbase/listings/}
> +\urldef{\virtiourltex}\url{\virtiourlbase/tex/}
> +\urldef{\virtiourlpdf}\url{\virtiourlbase/\virtiospecfile.pdf}
> +\urldef{\virtiourlhtml}\url{\virtiourlbase/\virtiospecfile.html}
> +\urldef{\virtiourlh}\url{\virtiourlbase/listings/virtio_queue.h}
> +\urldef{\virtiourllatestpdf}\url{https://docs.oasis-open.org/virtio/virtio/v\virtiorev/virtio-v\virtiorev.pdf}
> +\urldef{\virtiourllatesthtml}\url{https://docs.oasis-open.org/virtio/virtio/v\virtiorev/virtio-v\virtiorev.html}
>  \newcommand{\virtioworkproduct}{Standards Track Work Product}
>  \newcommand{\virtiooasiscopyright}{Copyright © OASIS Open 2023. All Rights Reserved.}
>
> --
> 2.47.3
>
>

Reviewed-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>

[PATCH v3 08/11] virtio-html.cfg: implement workaround for htlatex regression

[Alex Bennée]

A regression in htlatex broke the building of html in new Debian
Trixie systems. The bug has been reported upstream:

  https://tug.org/pipermail/tex4ht/2025q4/003774.html

and the following change is a suggested workaround until the eventual
fix is reaches the texlive (and by implication distro) repos:

  https://svn.gnu.org.ua/viewvc/tex4ht/trunk/lit/tex4ht-html4.tex?r1=1750&r2=1749&pathrev=1750

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
---
 virtio-html.cfg | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/virtio-html.cfg b/virtio-html.cfg
index c5b9a94..63bf9af 100644
--- a/virtio-html.cfg
+++ b/virtio-html.cfg
@@ -1,4 +1,5 @@
-\Preamble{html} 
+\Preamble{html}
+\expandafter\providecommand\csname hline:color\endcsname{000}
 \begin{document}
 	\ConfigureMark{chapter}{\HCode{<hr><span class="titlemark">}\thechapter\HCode{</span>}}
 	\ConfigureMark{paragraph}{\HCode{<span class="titlemark">}\theparagraph\HCode{</span>}}
-- 
2.47.3

Re: [PATCH v3 08/11] virtio-html.cfg: implement workaround for htlatex regression

[Manos Pitsidianakis]

On Fri, Oct 10, 2025 at 7:29 PM Alex Bennée <alex.bennee@linaro.org> wrote:
>
> A regression in htlatex broke the building of html in new Debian
> Trixie systems. The bug has been reported upstream:
>
>   https://tug.org/pipermail/tex4ht/2025q4/003774.html
>
> and the following change is a suggested workaround until the eventual
> fix is reaches the texlive (and by implication distro) repos:
>
>   https://svn.gnu.org.ua/viewvc/tex4ht/trunk/lit/tex4ht-html4.tex?r1=1750&r2=1749&pathrev=1750
>
> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
> ---
>  virtio-html.cfg | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/virtio-html.cfg b/virtio-html.cfg
> index c5b9a94..63bf9af 100644
> --- a/virtio-html.cfg
> +++ b/virtio-html.cfg
> @@ -1,4 +1,5 @@
> -\Preamble{html}
> +\Preamble{html}
> +\expandafter\providecommand\csname hline:color\endcsname{000}
>  \begin{document}
>         \ConfigureMark{chapter}{\HCode{<hr><span class="titlemark">}\thechapter\HCode{</span>}}
>         \ConfigureMark{paragraph}{\HCode{<span class="titlemark">}\theparagraph\HCode{</span>}}
> --
> 2.47.3
>
>

This fixes the problem for me.

Reviewed-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
Tested-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>

[PATCH v3 09/11] make-setup-generated: optionally add GIT metadata

[Alex Bennée]

This isn't a full conversion to git based metadata but it allows for
local builds to add git commit and tree status to the final built
product. The normal formal build process is unaffected and uses
manually updated VERSION, REVISION and REVISION-DATE metadata.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>

---
v3
  - re-flow logic so we either do "unofficial draft" or the formal
  OASIS doc type, not both
  - use git describe --tags for more descriptive git point
  - expose git version to VERSION
---
 make-setup-generated.sh | 96 +++++++++++++++++++++++++----------------
 makeall.sh              |  4 +-
 makehtml.sh             |  2 +-
 makepdf.sh              |  2 +-
 4 files changed, 63 insertions(+), 41 deletions(-)

diff --git a/make-setup-generated.sh b/make-setup-generated.sh
index 2c5c7f8..256f700 100755
--- a/make-setup-generated.sh
+++ b/make-setup-generated.sh
@@ -1,45 +1,67 @@
 #! /bin/sh
+#
+# Generate version and metadata preamble for the document
+#
 
 DATESTR=${DATESTR:-`cat REVISION-DATE 2>/dev/null`}
-if [ x"$DATESTR" = x ]; then
-    ISODATE=`git show --format=format:'%cd' --date=iso | head -n 1`
-    DATESTR=`date -d "$DATE" +'%d %B %Y'`
-fi
 
-case "$1" in
-    *-wd*)
-	STAGE=wd
-	STAGENAME="Working Draft"
-	WORKINGDRAFT=`basename "$1" | sed 's/.*-wd//'`
-	;;
-    *-os*)
-	STAGE=os
-	STAGENAME="OASIS Standard"
-	WORKINGDRAFT=""
-	;;
-    *-csd*)
-	STAGE=csd
-	WORKINGDRAFT=`basename "$1" | sed 's/.*-csd//'`
-	STAGENAME="Committee Specification Draft $WORKINGDRAFT"
-	;;
-    *-csprd*)
-	STAGE=csprd
-	WORKINGDRAFT=`basename "$1" | sed 's/.*-csprd//'`
-	STAGENAME="Committee Specification Draft $WORKINGDRAFT"
-	STAGEEXTRATITLE=" / \newline Public Review Draft $WORKINGDRAFT"
-	STAGEEXTRA=" / Public Review Draft $WORKINGDRAFT"
-	;;
-    *-cs*)
-	STAGE=cs
-	WORKINGDRAFT=`basename "$1" | sed 's/.*-cs//'`
-	STAGENAME="Committee Specification $WORKINGDRAFT"
-	;;
-    *)
-	echo Unknown doc type >&2
-	exit 1
-esac
+# If a second argument is passed we extract what we can from git
+# metadata (closest lightweight tag) and local tree status. This
+# allows us to build an unofficial draft and tag it appropriately.
+#
+# The formal build process skips this.
+if ! test -z "$2"; then
+    TAG=$(git describe --dirty --tags)
+    # base date on now
+    DATESTR=$(date +'%d %B %Y')
+    COMMIT=$(git describe --tags HEAD)
+
+    # Finally check if we have un-committed changes in the tree
+    if ! git diff-index --quiet HEAD -- ; then
+        COMMIT="$COMMIT with local changes"
+    fi
 
-VERSION=`echo "$1"| sed -e 's/virtio-v//' -e 's/-.*//'`
+    STAGE=draft
+    STAGENAME="Unofficial Draft"
+    WORKINGDRAFT=
+    VERSION="git @ $COMMIT"
+else
+    # These are all stages mandated by the OASIS process
+    case "$1" in
+        *-wd*)
+	    STAGE=wd
+	    STAGENAME="Working Draft"
+	    WORKINGDRAFT=`basename "$1" | sed 's/.*-wd//'`
+	    ;;
+        *-os*)
+	    STAGE=os
+	    STAGENAME="OASIS Standard"
+	    WORKINGDRAFT=""
+	    ;;
+        *-csd*)
+	    STAGE=csd
+	    WORKINGDRAFT=`basename "$1" | sed 's/.*-csd//'`
+	    STAGENAME="Committee Specification Draft $WORKINGDRAFT"
+	    ;;
+        *-csprd*)
+	    STAGE=csprd
+	    WORKINGDRAFT=`basename "$1" | sed 's/.*-csprd//'`
+	    STAGENAME="Committee Specification Draft $WORKINGDRAFT"
+	    STAGEEXTRATITLE=" / \newline Public Review Draft $WORKINGDRAFT"
+	    STAGEEXTRA=" / Public Review Draft $WORKINGDRAFT"
+	    ;;
+        *-cs*)
+	    STAGE=cs
+	    WORKINGDRAFT=`basename "$1" | sed 's/.*-cs//'`
+	    STAGENAME="Committee Specification $WORKINGDRAFT"
+	    ;;
+        *)
+	    echo Unknown doc type >&2
+	    exit 1
+    esac
+
+    VERSION=`echo "$1"| sed -e 's/virtio-v//' -e 's/-.*//'`
+fi
 
 #Prepend OASIS unless already there
 case "$STAGENAME" in
diff --git a/makeall.sh b/makeall.sh
index 37e6c34..5f5d5dc 100755
--- a/makeall.sh
+++ b/makeall.sh
@@ -3,8 +3,8 @@
 export SPECDOC=${SPECDOC:-`cat REVISION`}
 export DATESTR=${DATESTR:-`cat REVISION-DATE`}
 ./makezip.sh
-./makehtml.sh
-./makepdf.sh
+./makehtml.sh $1
+./makepdf.sh $1
 zip $SPECDOC.zip $SPECDOC.pdf
 echo Generated file $SPECDOC.zip
 echo To change output file name, set SPECDOC environment variable
diff --git a/makehtml.sh b/makehtml.sh
index 45b7080..cf1a8d7 100755
--- a/makehtml.sh
+++ b/makehtml.sh
@@ -1,7 +1,7 @@
 #!/bin/sh
 
 SPECDOC=${SPECDOC:-`cat REVISION`}
-./make-setup-generated.sh "$SPECDOC"
+./make-setup-generated.sh "$SPECDOC" $1
 
 cp virtio-html.tex $SPECDOC.tex
 
diff --git a/makepdf.sh b/makepdf.sh
index 9cae903..bdfb8e5 100755
--- a/makepdf.sh
+++ b/makepdf.sh
@@ -1,7 +1,7 @@
 #!/bin/sh
 
 SPECDOC=${SPECDOC:-`cat REVISION`}
-./make-setup-generated.sh "$SPECDOC"
+./make-setup-generated.sh "$SPECDOC" $1
 
 rm $SPECDOC.aux $SPECDOC.pdf $SPECDOC.out
 xelatex --jobname $SPECDOC virtio.tex
-- 
2.47.3

[PATCH v3 10/11] Makefile: add some simple make automations

[Alex Bennée]

This is just a helpful shortcut, especially when editing the documents
within an IDE which will offer up make targets to build the documents.

Reviewed-by: Parav Pandit <parav@nvidia.com>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>

---
v3
  - rename local to draft to make intent clear
  - update help text
---
 Makefile | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 Makefile

diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..f08f13c
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,34 @@
+# -*- Mode: makefile -*-
+#
+# Basic Makefile to aid automation of document building
+#
+
+.PHONY: all draft
+all:
+	./makeall.sh
+
+draft:
+	./makeall.sh draft
+
+.PHONY: html draft-html
+html:
+	./makehtml.sh
+
+draft-html:
+	./makehtml.sh draft
+
+.PHONY: clean
+clean:
+	git clean -fd
+
+.PHONY: help
+help:
+	@echo "Build the VIRTIO specification documents."
+	@echo ""
+	@echo "Possible operations are:"
+	@echo
+	@echo " $(MAKE)            Build everything"
+	@echo " $(MAKE) draft      Build unofficial draft"
+	@echo " $(MAKE) html       Build just html"
+	@echo " $(MAKE) draft-html Build just draft html"
+	@echo " $(MAKE) clean      Remove all intermediate files"
-- 
2.47.3

[PATCH v3 11/11] .github: add a runner to build the latest draft

[Alex Bennée]

This will run each time anything is pushed to the repository and store
the result in the release assets area of github. To see an example of
from this working branch see:

  https://github.com/stsquad/virtio-spec/releases

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>

---
v3
  - amend runner to use "make draft"
  - point at my repo examples
  - update to latest texlive action v3
---
 .github/workflows/deploy.yaml | 37 +++++++++++++++++++++++++++++++++++
 .github/workflows/test.yml    | 15 ++++++++++++++
 2 files changed, 52 insertions(+)
 create mode 100644 .github/workflows/deploy.yaml
 create mode 100644 .github/workflows/test.yml

diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml
new file mode 100644
index 0000000..30619ac
--- /dev/null
+++ b/.github/workflows/deploy.yaml
@@ -0,0 +1,37 @@
+name: Deploy current state
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: xu-cheng/texlive-action@v3
+        with:
+          scheme: full
+          run: |
+            apk add file font-liberation make zip
+            make draft
+            echo ${{ github.sha }} > Release.txt
+
+      - name: Create Draft Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{github.ref_name}}-${{ github.repository_owner }}-draft-v${{ github.run_number }}
+          release_name: Draft ${{ github.run_number }}
+          draft: false
+          prerelease: false
+
+      - name: Upload Release Asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: virtio-v1.4-wd01.pdf
+          asset_name: ${{github.ref_name}}-${{ github.repository_owner }}-draft-v${{ github.run_number }}.pdf
+          asset_content_type: application/pdf
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
new file mode 100644
index 0000000..34f4f44
--- /dev/null
+++ b/.github/workflows/test.yml
@@ -0,0 +1,15 @@
+name: CI
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: xu-cheng/texlive-action@v2
+        with:
+          scheme: full
+          run: |
+            apk add file make zip
+            make local-html
-- 
2.47.3

Re: [PATCH v3 00/11] QoL tweaks and github action

[Alex Bennée]

Alex Bennée <alex.bennee@linaro.org> writes:

Gentle ping.

Michael are you happy with the marking of the draft now?

> Some of these patches I've posted before. Along with general
> quality of life tweaks to the build scripts we also introduce a github
> workflow to build and publish the current working draft of the spec.
>
> I also fixed a build regression with htlatex which became apparent
> when I upgraded to Debian Trixie with a newer htlatex build.
>
> v3
>   - make unofficial version clearer
>   - tweak the make targets for clarity
>   - update commit messages
>
> v2
>
>   - added README.md cleanup
>   - applied r-b tags
>
> The following still need review:
>
>   .github: add a runner to build the latest draft
>   make-setup-generated: optionally add GIT metadata
>   virtio-html.cfg: implement workaround for htlatex regression
>   specvars.tex: properly wrap arguments to \urldef
>   README.md: convert embedded html to proper MarkDown
>   LICENSE.md: convert html to proper MarkDown
>
> Alex.
>
> Alex Bennée (11):
>   LICENSE.md: convert html to proper MarkDown
>   README.md: convert embedded html to proper MarkDown
>   REVISION: update to 1.4-wd01
>   .gitpublish: update base to current working branch
>   .b4-config: add project defaults
>   virtio-html.tex: sort package list
>   specvars.tex: properly wrap arguments to \urldef
>   virtio-html.cfg: implement workaround for htlatex regression
>   make-setup-generated: optionally add GIT metadata
>   Makefile: add some simple make automations
>   .github: add a runner to build the latest draft
>
>  .b4-config                    |   9 +
>  .github/workflows/deploy.yaml |  37 ++++
>  .github/workflows/test.yml    |  15 ++
>  .gitpublish                   |   2 +-
>  LICENSE.md                    |   8 +-
>  Makefile                      |  34 +++
>  README.md                     | 387 +++++++++++++---------------------
>  REVISION                      |   2 +-
>  make-setup-generated.sh       |  96 +++++----
>  makeall.sh                    |   4 +-
>  makehtml.sh                   |   2 +-
>  makepdf.sh                    |   2 +-
>  specvars.tex                  |  14 +-
>  virtio-html.cfg               |   3 +-
>  virtio-html.tex               |  30 +--
>  15 files changed, 339 insertions(+), 306 deletions(-)
>  create mode 100644 .b4-config
>  create mode 100644 .github/workflows/deploy.yaml
>  create mode 100644 .github/workflows/test.yml
>  create mode 100644 Makefile

-- 
Alex Bennée
Virtualisation Tech Lead @ Linaro

Re: [PATCH v3 00/11] QoL tweaks and github action

[Michael S. Tsirkin]

On Fri, Oct 17, 2025 at 03:10:41PM +0100, Alex Bennée wrote:
> Alex Bennée <alex.bennee@linaro.org> writes:
> 
> Gentle ping.
> 
> Michael are you happy with the marking of the draft now?


Could you fix the layout in the generated pdf?
If we are auto-generating it we better make it look sane ...

RE: [PATCH v3 00/11] QoL tweaks and github action

[Parav Pandit]

> From: Michael S. Tsirkin <mst@redhat.com>
> Sent: 19 October 2025 05:19 PM
> To: Alex Bennée <alex.bennee@linaro.org>
> Cc: virtio-comment@lists.linux.dev
> Subject: Re: [PATCH v3 00/11] QoL tweaks and github action
> 
> On Fri, Oct 17, 2025 at 03:10:41PM +0100, Alex Bennée wrote:
> > Alex Bennée <alex.bennee@linaro.org> writes:
> >
> > Gentle ping.
> >
> > Michael are you happy with the marking of the draft now?
> 
> 
> Could you fix the layout in the generated pdf?
> If we are auto-generating it we better make it look sane ...
> 

I didn't get a chance to go through v3 and some holidays due to my new year.
But short update for some of the patches, is that after discussing offline with Michael and Matias, we will be taking the patches through master for now.

And soon I would be tagging master for 1.4 release.
I imagine that Alex's patches likely will be after 1.4 release.

Re: [PATCH v3 00/11] QoL tweaks and github action

[Alex Bennée]

"Michael S. Tsirkin" <mst@redhat.com> writes:

> On Fri, Oct 17, 2025 at 03:10:41PM +0100, Alex Bennée wrote:
>> Alex Bennée <alex.bennee@linaro.org> writes:
>> 
>> Gentle ping.
>> 
>> Michael are you happy with the marking of the draft now?
>
>
> Could you fix the layout in the generated pdf?
> If we are auto-generating it we better make it look sane ...

I'm not sure if this is another regression with the latest texlive.
Could you tell me what version of tex you are running on fedora?

-- 
Alex Bennée
Virtualisation Tech Lead @ Linaro

Re: [PATCH v3 00/11] QoL tweaks and github action

[Michael S. Tsirkin]

On Mon, Oct 20, 2025 at 10:31:53AM +0100, Alex Bennée wrote:
> "Michael S. Tsirkin" <mst@redhat.com> writes:
> 
> > On Fri, Oct 17, 2025 at 03:10:41PM +0100, Alex Bennée wrote:
> >> Alex Bennée <alex.bennee@linaro.org> writes:
> >> 
> >> Gentle ping.
> >> 
> >> Michael are you happy with the marking of the draft now?
> >
> >
> > Could you fix the layout in the generated pdf?
> > If we are auto-generating it we better make it look sane ...
> 
> I'm not sure if this is another regression with the latest texlive.
> Could you tell me what version of tex you are running on fedora?
> 
> -- 
> Alex Bennée
> Virtualisation Tech Lead @ Linaro


$ xelatex --version
XeTeX 3.141592653-2.6-0.999995 (TeX Live 2023)
kpathsea version 6.3.5
Copyright 2023 SIL International, Jonathan Kew and Khaled Hosny.
There is NO warranty.  Redistribution of this software is
covered by the terms of both the XeTeX copyright and
the Lesser GNU General Public License.
For more information about these matters, see the file
named COPYING and the XeTeX source.
Primary author of XeTeX: Jonathan Kew.
Compiled with ICU version 76.1; using 76.1
Compiled with zlib version 1.3.1.zlib-ng; using 1.3.1.zlib-ng
Compiled with FreeType2 version 2.13.3; using 2.13.3
Compiled with Graphite2 version 1.3.14; using 1.3.14
Compiled with HarfBuzz version 10.2.0; using 10.4.0
Compiled with libpng version 1.6.44; using 1.6.44
Compiled with pplib version v2.05 less toxic i hope
Compiled with fontconfig version 2.15.0; using 2.16.0


-- 
MST