html fixes
cover html fixes
this fixes a ton of issues around makehtml
and makediff.
Michael S. Tsirkin (9):
makediff: look in subjects only
makediff: cherry pick table env change
admin: switch to tabularx
admin-cmds-device-parts: switch to tabularx
device-parts: switch to tabularx
admin-cmds-resource-objects: switch to tabularx
virtio: replace xltabular with ltablex
makediff: cherry pick switch to tabularx
admin: get rid of _ in labels
admin-cmds-capabilities.tex | 8 +++--- admin-cmds-device-parts.tex | 18 ++++++------- admin-cmds-legacy-interface.tex | 10 ++++---- admin-cmds-resource-objects.tex | 14 +++++----- admin.tex | 36 +++++++++++++------------- device-parts.tex | 28 ++++++++++---------- device-types/can/description.tex | 6 ++--- device-types/net/description.tex | 44 ++++++++++++++++---------------- makediff.sh | 4 ++- virtio.tex | 2 +- 10 files changed, 86 insertions(+), 84 deletions(-)
Signature · 1 line
MST
PATCH 1/9 makediff: look in subjects only
We currently use rev-list with -F to find commits. This helps if commit subject has any special characters but means that pattern can apply anywhere in the line. In particular, a common Fixes: (hash) "subject" pattern we started using implies that fixups are picked up instead of the commit.
For now, just switch to using regexp (dropping -F) and add "^" in front to only look for the string at beginning of the line.
We'll worry about more elaborate logic later, if it's ever needed.
Message-Id: <1f3f301f2e1baa87372764b9d342d04572e1c0ca.1721053494.git.mst@redhat.com>
--- makediff.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
makediff.sh +1 -1
@@ -18,7 +18,7 @@ cd "${cur}/old" git checkout $oldrev while read -r rev; do echo "Applying $rev" - git cherry-pick --keep-redundant-commits --allow-empty `git rev-list -1 -F --grep "$rev" $newrev` || exit 1 + git cherry-pick --keep-redundant-commits --allow-empty `git rev-list -1 --grep "^$rev" $newrev` || exit 1 done << 'EOF' editorial: allow for longer device id table: makediff 1.3 EOF
Signature · 1 line
MST
PATCH 2/9 makediff: cherry pick table env change
latexdiff can not cope with environment name changes. cherry pick to avoid confusing it.
Message-Id: <e69cb7619afb40089440f12cd002f1af5429b090.1720972792.git.mst@redhat.com>
--- makediff.sh | 1 + 1 file changed, 1 insertion(+)
makediff.sh +1 -0
@@ -21,6 +21,7 @@ while read -r rev; do git cherry-pick --keep-redundant-commits --allow-empty `git rev-list -1 --grep "^$rev" $newrev` || exit 1 done << 'EOF' editorial: allow for longer device id table: makediff 1.3 +admin: Prepare table for multipage listing EOF #mv specvars.tex specvars-orig.tex
Signature · 1 line
MST
PATCH 3/9 admin: switch to tabularx
In reply to Michael S. Tsirkinxltabular seems to confuse htlatex. Switch to an older tabularx which seems to be sufficient for our purposes.
--- admin.tex | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
admin.tex +2 -2
@@ -118,7 +118,7 @@ \subsection{Group administration commands}\label{sec:Basic Facilities of a Virti \field{opcode} specifies the command. The valid values for \field{opcode} can be found in the following table: -\begin{xltabular}{\textwidth}{ |l||l|X| } +\begin{tabularx}{\textwidth}{ |l||l|X| } \hline opcode & Name & Command Description \\ \hline \hline
@@ -163,7 +163,7 @@ \subsection{Group administration commands}\label{sec:Basic Facilities of a Virti \hline 0x8000 - 0xFFFF & - & Reserved for future commands (possibly using a different structure) \\ \hline -\end{xltabular} +\end{tabularx} The \field{group_type} specifies the group type identifier. The \field{group_member_id} specifies the member identifier within the group.
Signature · 1 line
MST
PATCH 4/9 admin-cmds-device-parts: switch to tabularx
In reply to Michael S. Tsirkinxltabular seems to confuse htlatex. Switch to an older tabularx which seems to be sufficient for our purposes.
--- admin-cmds-device-parts.tex | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
admin-cmds-device-parts.tex +2 -2
@@ -297,7 +297,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev \begin{table}[H] \caption{Device parts order} \label{table:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts order/ Device parts order} -\begin{xltabular}{\textwidth}{ |l|l|X| } +\begin{tabularx}{\textwidth}{ |l|l|X| } \hline Part name & Optional & Mandatory preceding parts \\ \hline \hline
@@ -317,7 +317,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev VIRTIO_DEV_PART_DEVICE_STATUS, VIRTIO_DEV_PART_VQ_CFG \\ \hline \hline -\end{xltabular} +\end{tabularx} \end{table} \devicenormative{\subparagraph}{Device parts}{Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts}
Signature · 1 line
MST
PATCH 5/9 device-parts: switch to tabularx
In reply to Michael S. Tsirkinxltabular seems to confuse htlatex. Switch to an older tabularx which seems to be sufficient for our purposes.
--- device-parts.tex | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
device-parts.tex +2 -2
@@ -85,7 +85,7 @@ \subsection{Common device parts}\label{sec:Basic Facilities of a Virtio Device / \begin{table} \caption{Common device parts} \label{table:Basic Facilities of a Virtio Device / Device parts / Common device parts} -\begin{xltabular}{\textwidth}{ |l||l|X| } +\begin{tabularx}{\textwidth}{ |l||l|X| } \hline Type & Name & Description \\ \hline \hline
@@ -104,7 +104,7 @@ \subsection{Common device parts}\label{sec:Basic Facilities of a Virtio Device / 0x106 - 0x2FF & - & Common device parts range reserved for future \\ \hline \hline -\end{xltabular} +\end{tabularx} \end{table} \subsubsection{VIRTIO_DEV_PART_DEV_FEATURES}
Signature · 1 line
MST
PATCH 6/9 admin-cmds-resource-objects: switch to tabularx
In reply to Michael S. Tsirkinxltabular seems to confuse htlatex. Switch to an older tabularx which seems to be sufficient for our purposes.
--- admin-cmds-resource-objects.tex | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
admin-cmds-resource-objects.tex +2 -2
@@ -65,7 +65,7 @@ \subsubsection{Device resource objects}\label{sec:Basic Facilities of a Virtio D Following generic resource objects are defined which are described separately. -\begin{xltabular}{\textwidth}{ |X||X|X| } +\begin{tabularx}{\textwidth}{ |X||X|X| } \hline Resource object type & Name & Description \\ \hline \hline
@@ -74,7 +74,7 @@ \subsubsection{Device resource objects}\label{sec:Basic Facilities of a Virtio D 0x001-0x1ff & - & Generic resource object range reserved \\ \hline \hline -\end{xltabular} +\end{tabularx} When the device resets, it starts with zero resources of each type; the driver can create resources up to the published \field{limit}. The driver can
Signature · 1 line
MST
PATCH 7/9 virtio: replace xltabular with ltablex
In reply to Michael S. Tsirkinnow that we only use tabularx, switch to ltablex to make tabularx tables paginate properly.
--- virtio.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
virtio.tex +1 -1
@@ -35,7 +35,7 @@ \usepackage{xltxtra} \usepackage{etoolbox} \usepackage{tabularx} -\usepackage{xltabular} +\usepackage{ltablex} \usepackage{underscore} \usepackage{xstring} \usepackage{enumitem}
Signature · 1 line
MST
PATCH 8/9 makediff: cherry pick switch to tabularx
In reply to Michael S. Tsirkin--- makediff.sh | 1 + 1 file changed, 1 insertion(+)
makediff.sh +1 -0
@@ -22,6 +22,7 @@ while read -r rev; do done << 'EOF' editorial: allow for longer device id table: makediff 1.3 admin: Prepare table for multipage listing +admin: switch to tabularx EOF #mv specvars.tex specvars-orig.tex
Signature · 1 line
MST
PATCH 9/9 admin: get rid of _ in labels
In reply to Michael S. Tsirkinit's not the 1st time we find out underscores in labels confuse latexdiff machinery when generating html.
Errors look like this:
! Missing \endcsname inserted.
<to be read again>
\unhbox
....
?
! Emergency stop.
<to be read again>
\unhbox
To fix, convert underscores in labels to dashes.
--- admin-cmds-capabilities.tex | 8 +++--- admin-cmds-device-parts.tex | 14 +++++----- admin-cmds-legacy-interface.tex | 10 ++++---- admin-cmds-resource-objects.tex | 10 ++++---- admin.tex | 32 +++++++++++------------ device-parts.tex | 24 ++++++++--------- device-types/can/description.tex | 6 ++--- device-types/net/description.tex | 44 ++++++++++++++++---------------- 8 files changed, 74 insertions(+), 74 deletions(-)
admin-cmds-capabilities.tex +4 -4
@@ -60,7 +60,7 @@ \subsubsection{Device and driver capabilities}\label{sec:Basic Facilities of a V \hline Id & Name & Description \\ \hline \hline -0x0000 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / VIRTIO_DEV_PARTS_CAP]{VIRTIO_DEV_PARTS_CAP} & Device parts capability \\ +0x0000 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / VIRTIO-DEV-PARTS-CAP]{VIRTIO_DEV_PARTS_CAP} & Device parts capability \\ \hline 0x0001-0x07ff & - & Generic capability for all device types \\ \hline
@@ -79,7 +79,7 @@ \subsubsection{Device and driver capabilities}\label{sec:Basic Facilities of a V \item VIRTIO_ADMIN_CMD_DRIVER_CAP_SET \end{enumerate} -\paragraph{VIRTIO_ADMIN_CMD_CAP_ID_LIST_QUERY}\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device and driver capabilities / VIRTIO_ADMIN_CMD_CAP_ID_LIST_QUERY} +\paragraph{VIRTIO_ADMIN_CMD_CAP_ID_LIST_QUERY}\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device and driver capabilities / VIRTIO-ADMIN-CMD-CAP-ID-LIST-QUERY} This command queries the bitmap of capability ids listed in \ref{table:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device and driver capabilities / capability ids}.
@@ -119,7 +119,7 @@ \subsubsection{Device and driver capabilities}\label{sec:Basic Facilities of a V The array is also allowed to be larger and to additionally include an arbitrary number of all-zero entries. -\paragraph{VIRTIO_ADMIN_CMD_DEVICE_CAP_GET}\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device and driver capabilities / VIRTIO_ADMIN_CMD_DEVICE_CAP_GET} +\paragraph{VIRTIO_ADMIN_CMD_DEVICE_CAP_GET}\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device and driver capabilities / VIRTIO-ADMIN-CMD-DEVICE-CAP-GET} This command gets the device capability for the specified capability id \field{id}.
@@ -151,7 +151,7 @@ \subsubsection{Device and driver capabilities}\label{sec:Basic Facilities of a V by the device. Each capability uses different capability specific \field{cap_specific_data} and is described separately. -\paragraph{VIRTIO_ADMIN_CMD_DRIVER_CAP_SET}\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device and driver capabilities / VIRTIO_ADMIN_CMD_DRIVER_CAP_SET} +\paragraph{VIRTIO_ADMIN_CMD_DRIVER_CAP_SET}\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device and driver capabilities / VIRTIO-ADMIN-CMD-DRIVER-CAP-SET} This command sets the driver capability, indicating to the device which capability the driver uses. The driver can set a resource object limit capability that is smaller
admin-cmds-device-parts.tex +7 -7
@@ -37,7 +37,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev the device itself will not initiate any transport requests. \paragraph{VIRTIO_DEV_PARTS_CAP} -\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / VIRTIO_DEV_PARTS_CAP} +\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / VIRTIO-DEV-PARTS-CAP} The capability VIRTIO_DEV_PARTS_CAP indicates the device parts resource objects limit. \field{cap_specific_data} is in the format \field{struct virtio_dev_parts_cap}.
@@ -54,13 +54,13 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev \field{set_parts_resource_objects_limit} indicates the supported device parts resource objects for restoring the device parts. -\paragraph{VIRTIO_RESOURCE_OBJ_DEV_PARTS}\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / VIRTIO_RESOURCE_OBJ_DEV_PARTS} +\paragraph{VIRTIO_RESOURCE_OBJ_DEV_PARTS}\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / VIRTIO-RESOURCE-OBJ-DEV-PARTS} A device parts resource object is used to either get or set the device parts. Before performing any get or set operation for the device parts, the driver creates the device parts resource object VIRTIO_RESOURCE_OBJ_DEV_PARTS using the administration command -\nameref{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE}. +\nameref{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO-ADMIN-CMD-RESOURCE-OBJ-CREATE}. The driver indicates the intended purpose (get or set) at the time of creating the device parts resource object. For the device parts resource object, both \field{resource_obj_specific_data} and
@@ -96,7 +96,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev \end{enumerate} \subparagraph{VIRTIO_ADMIN_CMD_DEV_PARTS_METADATA_GET} -\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts handling commands / VIRTIO_ADMIN_CMD_DEV_PARTS_METADATA_GET} +\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts handling commands / VIRTIO-ADMIN-CMD-DEV-PARTS-METADATA-GET} This command obtains the metadata of the device parts. This metadata includes the maximum size of the device parts, the count of device parts, and a list of
@@ -166,7 +166,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev for the response. \subparagraph{VIRTIO_ADMIN_CMD_DEV_PARTS_GET} -\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts handling commands / VIRTIO_ADMIN_CMD_DEV_PARTS_GET} +\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts handling commands / VIRTIO-ADMIN-CMD-DEV-PARTS-GET} This command captures the device parts. For the command VIRTIO_ADMIN_CMD_DEV_PARTS_GET, \field{opcode} is set to 0xf.
@@ -210,7 +210,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev If the requested device part does not exist, the device skips the device part without any error. -\subparagraph{VIRTIO_ADMIN_CMD_DEV_PARTS_SET}\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts handling commands / VIRTIO_ADMIN_CMD_DEV_PARTS_SET} +\subparagraph{VIRTIO_ADMIN_CMD_DEV_PARTS_SET}\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts handling commands / VIRTIO-ADMIN-CMD-DEV-PARTS-SET} This command sets one or multiple device parts. For the command VIRTIO_ADMIN_CMD_DEV_PARTS_SET, \field{opcode} is set to 0x10.
@@ -242,7 +242,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev When the command fails with a status other than VIRTIO_ADMIN_STATUS_OK, the device does not have any side effects. -\subparagraph{VIRTIO_ADMIN_CMD_DEV_MODE_SET}\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts handling commands / VIRTIO_ADMIN_CMD_DEV_MODE_SET} +\subparagraph{VIRTIO_ADMIN_CMD_DEV_MODE_SET}\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts handling commands / VIRTIO-ADMIN-CMD-DEV-MODE-SET} This command either stops the device from initiating any transport requests or resumes the device operation. For the command VIRTIO_ADMIN_CMD_DEV_MODE_SET,
admin-cmds-legacy-interface.tex +5 -5
@@ -30,7 +30,7 @@ \subsubsection{Legacy Interfaces}\label{sec:Basic Facilities of a Virtio Device that little-endian format is assumed unconditionally. \paragraph{VIRTIO_ADMIN_CMD_LEGACY_COMMON_CFG_WRITE} -\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO_ADMIN_CMD_LEGACY_COMMON_CFG_WRITE} +\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO-ADMIN-CMD-LEGACY-COMMON-CFG-WRITE} This command has the same effect as writing into the virtio common configuration structure through the legacy interface. The \field{command_specific_data} is in
@@ -60,7 +60,7 @@ \subsubsection{Legacy Interfaces}\label{sec:Basic Facilities of a Virtio Device This command has no command specific result. \paragraph{VIRTIO_ADMIN_CMD_LEGACY_COMMON_CFG_READ} -\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO_ADMIN_CMD_LEGACY_COMMON_CFG_READ} +\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO-ADMIN-CMD-LEGACY-COMMON-CFG-READ} This command has the same effect as reading from the virtio common configuration structure through the legacy interface. The \field{command_specific_data} is in
@@ -96,7 +96,7 @@ \subsubsection{Legacy Interfaces}\label{sec:Basic Facilities of a Virtio Device \field{data}. \paragraph{VIRTIO_ADMIN_CMD_LEGACY_DEV_CFG_WRITE} -\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO_ADMIN_CMD_LEGACY_DEV_CFG_WRITE} +\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO-ADMIN-CMD-LEGACY-DEV-CFG-WRITE} This command has the same effect as writing into the virtio device-specific configuration through the legacy interface. The \field{command_specific_data} is in
@@ -126,7 +126,7 @@ \subsubsection{Legacy Interfaces}\label{sec:Basic Facilities of a Virtio Device This command has no command specific result. \paragraph{VIRTIO_ADMIN_CMD_LEGACY_DEV_CFG_READ} -\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO_ADMIN_CMD_LEGACY_DEV_CFG_READ} +\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO-ADMIN-CMD-LEGACY-DEV-CFG-READ} This command has the same effect as reading from the virtio device-specific configuration through the legacy interface. The \field{command_specific_data} is in
@@ -163,7 +163,7 @@ \subsubsection{Legacy Interfaces}\label{sec:Basic Facilities of a Virtio Device The length of the data read is simply the length of \field{data}. \paragraph{VIRTIO_ADMIN_CMD_LEGACY_NOTIFY_INFO} -\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO_ADMIN_CMD_LEGACY_NOTIFY_INFO} +\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO-ADMIN-CMD-LEGACY-NOTIFY-INFO} The driver of the owner device can send a driver notification to the member device operated using the legacy interface by executing
admin-cmds-resource-objects.tex +5 -5
@@ -69,7 +69,7 @@ \subsubsection{Device resource objects}\label{sec:Basic Facilities of a Virtio D \hline Resource object type & Name & Description \\ \hline \hline -0x000 & VIRTIO_RESOURCE_OBJ_DEV_PARTS & Device parts object, see \ref{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / VIRTIO_RESOURCE_OBJ_DEV_PARTS} \\ +0x000 & VIRTIO_RESOURCE_OBJ_DEV_PARTS & Device parts object, see \ref{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / VIRTIO-RESOURCE-OBJ-DEV-PARTS} \\ \hline 0x001-0x1ff & - & Generic resource object range reserved \\ \hline
@@ -109,7 +109,7 @@ \subsubsection{Device resource objects}\label{sec:Basic Facilities of a Virtio D \field{id} uniquely identifies the resource object of a specified \field{type}. \paragraph{VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE} -\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE} +\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO-ADMIN-CMD-RESOURCE-OBJ-CREATE} This command creates the specified resource object of \field{type} identified by the resource id \field{id}. The valid range of \field{id} is defined by the
@@ -142,7 +142,7 @@ \subsubsection{Device resource objects}\label{sec:Basic Facilities of a Virtio D This command has no command specific result. \paragraph{VIRTIO_ADMIN_CMD_RESOURCE_OBJ_MODIFY} -\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_MODIFY} +\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO-ADMIN-CMD-RESOURCE-OBJ-MODIFY} This command modifies the attributes of an existing device resource object. For the command VIRTIO_ADMIN_CMD_RESOURCE_OBJ_MODIFY, \field{opcode} is set to 0xb.
@@ -167,7 +167,7 @@ \subsubsection{Device resource objects}\label{sec:Basic Facilities of a Virtio D set to the values supplied in \field{resource_obj_specific_data}. \paragraph{VIRTIO_ADMIN_CMD_RESOURCE_OBJ_QUERY} -\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_QUERY} +\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO-ADMIN-CMD-RESOURCE-OBJ-QUERY} This command queries attributes of the existing resource object. For the command VIRTIO_ADMIN_CMD_RESOURCE_OBJ_QUERY, \field{opcode} is set to 0xc.
@@ -198,7 +198,7 @@ \subsubsection{Device resource objects}\label{sec:Basic Facilities of a Virtio D resource object are are set in \field{resource_obj_specific_data}. \paragraph{VIRTIO_ADMIN_CMD_RESOURCE_OBJ_DESTROY} -\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_DESTROY} +\label{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO-ADMIN-CMD-RESOURCE-OBJ-DESTROY} This command destroys the previously created device resource object. For the command VIRTIO_ADMIN_CMD_RESOURCE_OBJ_DESTROY, \field{opcode} is set to 0xd.
admin.tex +16 -16
@@ -126,37 +126,37 @@ \subsection{Group administration commands}\label{sec:Basic Facilities of a Virti \hline 0x0001 & VIRTIO_ADMIN_CMD_LIST_USE & Provides to device list of commands used for this group type \\ \hline -0x0002 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO_ADMIN_CMD_LEGACY_COMMON_CFG_WRITE]{VIRTIO_ADMIN_CMD_LEGACY_COMMON_CFG_WRITE} & Writes into the legacy common configuration structure \\ +0x0002 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO-ADMIN-CMD-LEGACY-COMMON-CFG-WRITE]{VIRTIO_ADMIN_CMD_LEGACY_COMMON_CFG_WRITE} & Writes into the legacy common configuration structure \\ \hline -0x0003 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO_ADMIN_CMD_LEGACY_COMMON_CFG_READ]{VIRTIO_ADMIN_CMD_LEGACY_COMMON_CFG_READ} & Reads from the legacy common configuration structure \\ +0x0003 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO-ADMIN-CMD-LEGACY-COMMON-CFG-READ]{VIRTIO_ADMIN_CMD_LEGACY_COMMON_CFG_READ} & Reads from the legacy common configuration structure \\ \hline -0x0004 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO_ADMIN_CMD_LEGACY_DEV_CFG_WRITE]{VIRTIO_ADMIN_CMD_LEGACY_DEV_CFG_WRITE} & Writes into the legacy device configuration structure \\ +0x0004 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO-ADMIN-CMD-LEGACY-DEV-CFG-WRITE]{VIRTIO_ADMIN_CMD_LEGACY_DEV_CFG_WRITE} & Writes into the legacy device configuration structure \\ \hline -0x0005 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO_ADMIN_CMD_LEGACY_DEV_CFG_READ]{VIRTIO_ADMIN_CMD_LEGACY_DEV_CFG_READ} & Reads into the legacy device configuration structure \\ +0x0005 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO-ADMIN-CMD-LEGACY-DEV-CFG-READ]{VIRTIO_ADMIN_CMD_LEGACY_DEV_CFG_READ} & Reads into the legacy device configuration structure \\ \hline -0x0006 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO_ADMIN_CMD_LEGACY_NOTIFY_INFO]{VIRTIO_ADMIN_CMD_LEGACY_NOTIFY_INFO} & Query the notification region information \\ +0x0006 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Legacy Interface / VIRTIO-ADMIN-CMD-LEGACY-NOTIFY-INFO]{VIRTIO_ADMIN_CMD_LEGACY_NOTIFY_INFO} & Query the notification region information \\ \hline -0x0007 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device and driver capabilities / VIRTIO_ADMIN_CMD_CAP_ID_LIST_QUERY]{VIRTIO_ADMIN_CMD_CAP_ID_LIST_QUERY} & Query the supported device capabilities bitmap \\ +0x0007 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device and driver capabilities / VIRTIO-ADMIN-CMD-CAP-ID-LIST-QUERY]{VIRTIO_ADMIN_CMD_CAP_ID_LIST_QUERY} & Query the supported device capabilities bitmap \\ \hline -0x0008 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device and driver capabilities / VIRTIO_ADMIN_CMD_DEVICE_CAP_GET]{VIRTIO_ADMIN_CMD_DEVICE_CAP_GET} & Get the device capabilities \\ +0x0008 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device and driver capabilities / VIRTIO-ADMIN-CMD-DEVICE-CAP-GET]{VIRTIO_ADMIN_CMD_DEVICE_CAP_GET} & Get the device capabilities \\ \hline -0x0009 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device and driver capabilities / VIRTIO_ADMIN_CMD_DRIVER_CAP_SET]{VIRTIO_ADMIN_CMD_DRIVER_CAP_SET} & Set the driver capabilities \\ +0x0009 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device and driver capabilities / VIRTIO-ADMIN-CMD-DRIVER-CAP-SET]{VIRTIO_ADMIN_CMD_DRIVER_CAP_SET} & Set the driver capabilities \\ \hline -0x000a & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE]{VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE} & Create a device resource object \\ +0x000a & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO-ADMIN-CMD-RESOURCE-OBJ-CREATE]{VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE} & Create a device resource object \\ \hline -0x000c & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_MODIFY]{VIRTIO_ADMIN_CMD_RESOURCE_OBJ_MODIFY} & Modify a device resource object \\ +0x000c & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO-ADMIN-CMD-RESOURCE-OBJ-MODIFY]{VIRTIO_ADMIN_CMD_RESOURCE_OBJ_MODIFY} & Modify a device resource object \\ \hline -0x000b & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_QUERY]{VIRTIO_ADMIN_CMD_RESOURCE_OBJ_QUERY} & Query a device resource object \\ +0x000b & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO-ADMIN-CMD-RESOURCE-OBJ-QUERY]{VIRTIO_ADMIN_CMD_RESOURCE_OBJ_QUERY} & Query a device resource object \\ \hline -0x000d & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_DESTROY]{VIRTIO_ADMIN_CMD_RESOURCE_OBJ_DESTROY} & Destroy a device resource object \\ +0x000d & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO-ADMIN-CMD-RESOURCE-OBJ-DESTROY]{VIRTIO_ADMIN_CMD_RESOURCE_OBJ_DESTROY} & Destroy a device resource object \\ \hline -0x000e & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts handling commands / VIRTIO_ADMIN_CMD_DEV_PARTS_METADATA_GET]{VIRTIO_ADMIN_CMD_DEV_PARTS_METADATA_GET} & Get the metadata of the device parts \\ +0x000e & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts handling commands / VIRTIO-ADMIN-CMD-DEV-PARTS-METADATA-GET]{VIRTIO_ADMIN_CMD_DEV_PARTS_METADATA_GET} & Get the metadata of the device parts \\ \hline -0x000f & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts handling commands / VIRTIO_ADMIN_CMD_DEV_PARTS_GET]{VIRTIO_ADMIN_CMD_DEV_PARTS_GET} & Get the device parts \\ +0x000f & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts handling commands / VIRTIO-ADMIN-CMD-DEV-PARTS-GET]{VIRTIO_ADMIN_CMD_DEV_PARTS_GET} & Get the device parts \\ \hline -0x0010 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts handling commands / VIRTIO_ADMIN_CMD_DEV_PARTS_SET]{VIRTIO_ADMIN_CMD_DEV_PARTS_SET} & Set the device parts \\ +0x0010 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts handling commands / VIRTIO-ADMIN-CMD-DEV-PARTS-SET]{VIRTIO_ADMIN_CMD_DEV_PARTS_SET} & Set the device parts \\ \hline -0x0011 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts handling commands / VIRTIO_ADMIN_CMD_DEV_MODE_SET]{VIRTIO_ADMIN_CMD_DEV_MODE_SET} & Stop or resume the device \\ +0x0011 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts handling commands / VIRTIO-ADMIN-CMD-DEV-MODE-SET]{VIRTIO_ADMIN_CMD_DEV_MODE_SET} & Stop or resume the device \\ \hline \hline 0x0013 - 0x7FFF & - & Commands using \field{struct virtio_admin_cmd} \\
device-parts.tex +12 -12
@@ -89,17 +89,17 @@ \subsection{Common device parts}\label{sec:Basic Facilities of a Virtio Device / \hline Type & Name & Description \\ \hline \hline -0x100 & VIRTIO_DEV_PART_DEV_FEATURES & Device features, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEV_FEATURES} \\ +0x100 & VIRTIO_DEV_PART_DEV_FEATURES & Device features, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO-DEV-PART-DEV-FEATURES} \\ \hline -0x101 & VIRTIO_DEV_PART_DRV_FEATURES & Driver features, \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DRV_FEATURES} \\ +0x101 & VIRTIO_DEV_PART_DRV_FEATURES & Driver features, \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO-DEV-PART-DRV-FEATURES} \\ \hline -0x102 & VIRTIO_DEV_PART_PCI_COMMON_CFG & PCI common configuration, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_PCI_COMMON_CFG} \\ +0x102 & VIRTIO_DEV_PART_PCI_COMMON_CFG & PCI common configuration, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO-DEV-PART-PCI-COMMON-CFG} \\ \hline -0x103 & VIRTIO_DEV_PART_DEVICE_STATUS & Device status, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEVICE_STATUS} \\ +0x103 & VIRTIO_DEV_PART_DEVICE_STATUS & Device status, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO-DEV-PART-DEVICE-STATUS} \\ \hline -0x104 & VIRTIO_DEV_PART_VQ_CFG & Virtqueue configuration, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_CFG} \\ +0x104 & VIRTIO_DEV_PART_VQ_CFG & Virtqueue configuration, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO-DEV-PART-VQ-CFG} \\ \hline -0x105 & VIRTIO_DEV_PART_VQ_NOTIFY_CFG & Virtqueue notification configuration, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_NOTIFY_CFG} \\ +0x105 & VIRTIO_DEV_PART_VQ_NOTIFY_CFG & Virtqueue notification configuration, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO-DEV-PART-VQ-NOTIFY-CFG} \\ \hline 0x106 - 0x2FF & - & Common device parts range reserved for future \\ \hline
@@ -108,7 +108,7 @@ \subsection{Common device parts}\label{sec:Basic Facilities of a Virtio Device / \end{table} \subsubsection{VIRTIO_DEV_PART_DEV_FEATURES} -\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEV_FEATURES} +\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO-DEV-PART-DEV-FEATURES} For VIRTIO_DEV_PART_DEV_FEATURES, \field{part_type} is set to 0x100. The VIRTIO_DEV_PART_DEV_FEATURES field indicates features offered by the device.
@@ -130,7 +130,7 @@ \subsubsection{VIRTIO_DEV_PART_DEV_FEATURES} \end{lstlisting} \subsubsection{VIRTIO_DEV_PART_DRV_FEATURES} -\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DRV_FEATURES} +\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO-DEV-PART-DRV-FEATURES} For VIRTIO_DEV_PART_DRV_FEATURES, \field{part_type} is set to 0x101. The VIRTIO_DEV_PART_DRV_FEATURES field indicates features set by the driver.
@@ -143,7 +143,7 @@ \subsubsection{VIRTIO_DEV_PART_DRV_FEATURES} one instance of it in the get or set commands. \subsubsection{VIRTIO_DEV_PART_PCI_COMMON_CFG} -\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_PCI_COMMON_CFG} +\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO-DEV-PART-PCI-COMMON-CFG} For VIRTIO_DEV_PART_PCI_COMMON_CFG, \field{part_type} is set to 0x102. VIRTIO_DEV_PART_PCI_COMMON_CFG refers to the common device configuration
@@ -158,7 +158,7 @@ \subsubsection{VIRTIO_DEV_PART_PCI_COMMON_CFG} get or set commands; each such part corresponds to a unique \field{offset}. \subsubsection{VIRTIO_DEV_PART_DEVICE_STATUS} -\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEVICE_STATUS} +\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO-DEV-PART-DEVICE-STATUS} For VIRTIO_DEV_PART_DEVICE_STATUS, \field{part_type} is set to 0x103. The VIRTIO_DEV_PART_DEVICE_STATUS field indicates the device status as listed in
@@ -173,7 +173,7 @@ \subsubsection{VIRTIO_DEV_PART_DEVICE_STATUS} commands. \subsubsection{VIRTIO_DEV_PART_VQ_CFG} -\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_CFG} +\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO-DEV-PART-VQ-CFG} For VIRTIO_DEV_PART_VQ_CFG, \field{part_type} is set to 0x104. \field{value} is in the format \field{struct virtio_dev_part_vq_cfg}.
@@ -200,7 +200,7 @@ \subsubsection{VIRTIO_DEV_PART_VQ_CFG} by the \field{vq_index.index}. \subsubsection{VIRTIO_DEV_PART_VQ_NOTIFY_CFG} -\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_NOTIFY_CFG} +\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO-DEV-PART-VQ-NOTIFY-CFG} For VIRTIO_DEV_PART_VQ_NOTIFY_CFG, \field{part_type} is set to 0x105. \field{value} is in the format \field{struct virtio_dev_part_vq_notify_data}.
device-types/can/description.tex +3 -3
@@ -89,7 +89,7 @@ \subsection{Device configuration layout}\label{sec:Device Types / CAN Device / D The driver MUST populate the \field{Rxq} with empty device-writeable buffers of at least the size of struct virtio_can_rx, see section -\ref{struct virtio_can_rx}. +\ref{struct virtio-can-rx}. \subsection{Device Operation}\label{sec:Device Types / CAN Device / Device Operation}
@@ -152,7 +152,7 @@ \subsubsection{Controller Mode}\label{sec:Device Types / CAN Device / Device Ope The driver transmits messages by placing outgoing CAN messages in the \field{Txq} virtqueue. -\label{struct virtio_can_tx_out} +\label{struct virtio-can-tx-out} \begin{lstlisting} struct virtio_can_tx_out { #define VIRTIO_CAN_TX 0x0001
@@ -207,7 +207,7 @@ \subsubsection{CAN Message Reception}\label{sec:Device Types / CAN Device / Devi Messages can be received by providing empty incoming buffers to the virtqueue \field{Rxq}. -\label{struct virtio_can_rx} +\label{struct virtio-can-rx} \begin{lstlisting} struct virtio_can_rx { #define VIRTIO_CAN_RX 0x0101
device-types/net/description.tex +22 -22
143 lines not on this page · raw message
Signature · 1 line
MST
Re: [PATCH 9/9] admin: get rid of _ in labels
Quoted 9 lines · Michael S. Tsirkin
it's not the 1st time we find out underscores in labels confuse latexdiff machinery when generating html.
Errors look like this:! Missing \endcsname inserted.
<to be read again>
\unhbox
....
Quoted 7 lines
?
! Emergency stop.
<to be read again>
\unhboxTo fix, convert underscores in labels to dashes.
Hm... should we add a "Avoid common pitfalls" section to the README? Anything else other than avoiding underscores in labels?
(Not sure if that will help, things like that are easy to miss.)
Re: [PATCH 9/9] admin: get rid of _ in labels
Quoted 16 lines · Cornelia Huck
Quoted 14 lines · Michael S. Tsirkin
it's not the 1st time we find out underscores in labels confuse latexdiff machinery when generating html.
Errors look like this:! Missing \endcsname inserted.
<to be read again>
\unhbox
....?
! Emergency stop.
<to be read again>
\unhbox
Quoted 7 lines
Quoted 2 lines
To fix, convert underscores in labels to dashes.
Hm... should we add a "Avoid common pitfalls" section to the README? Anything else other than avoiding underscores in labels?
(Not sure if that will help, things like that are easy to miss.)
Some kind of CI checking patches might help.
Quoted 31 lines
From: Michael S. Tsirkin <[email protected]>
Sent: Monday, July 15, 2024 10:19 PM
To: [email protected]
Subject: [PATCH 0/9] html fixesthis fixes a ton of issues around makehtml and makediff.
Michael S. Tsirkin (9):
makediff: look in subjects only
makediff: cherry pick table env change
admin: switch to tabularx
admin-cmds-device-parts: switch to tabularx
device-parts: switch to tabularx
admin-cmds-resource-objects: switch to tabularx
virtio: replace xltabular with ltablex
makediff: cherry pick switch to tabularx
admin: get rid of _ in labelsadmin-cmds-capabilities.tex | 8 +++--- admin-cmds-device-parts.tex | 18 ++++++------- admin-cmds-legacy-interface.tex | 10 ++++---- admin-cmds-resource- objects.tex | 14 +++++----- admin.tex | 36 +++++++++++++------------- device-parts.tex | 28 ++++++++++---------- device-types/can/description.tex | 6 ++--- device-types/net/description.tex | 44 ++++++++++++++++---------------- makediff.sh | 4 ++- virtio.tex | 2 +- 10 files changed, 86 insertions(+), 84 deletions(-)
Quoted 3 lines
--
MST
Back from a long travel, couldn't respond before.
I verified further. Changes looks good.
Thanks a lot Michael.