content.tex Fix Driver notifications label
PATCH 1/1 content.tex Fix Driver notifications label
Driver notifications section is under "Basic Facilities of a Virtio Device". However, the label is placed under "Virtqueues" section.
Fix the label references.
--- content.tex | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)
content.tex +7 -7
@@ -396,7 +396,7 @@ \subsubsection{Virtqueue Re-enable}\label{sec:Basic Facilities of a Virtio Devic \input{packed-ring.tex} -\section{Driver Notifications} \label{sec:Virtqueues / Driver notifications} +\section{Driver Notifications} \label{sec:Basic Facilities of a Virtio Device / Driver notifications} The driver is sometimes required to send an available buffer notification to the device.
@@ -1624,7 +1624,7 @@ \subsubsection{Available Buffer Notifications}\label{sec:Virtio Transport Option the following 32-bit value to the Queue Notify address: \lstinputlisting{notifications-le.c} -See \ref{sec:Virtqueues / Driver notifications}~\nameref{sec:Virtqueues / Driver notifications} +See \ref{sec:Basic Facilities of a Virtio Device / Driver notifications}~\nameref{sec:Basic Facilities of a Virtio Device / Driver notifications} for the definition of the components. See \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Notification capability}
@@ -1879,7 +1879,7 @@ \subsection{MMIO Device Register Layout}\label{sec:Virtio Transport Options / Vi \lstinputlisting{notifications-le.c} - See \ref{sec:Virtqueues / Driver notifications}~\nameref{sec:Virtqueues / Driver notifications} + See \ref{sec:Basic Facilities of a Virtio Device / Driver notifications}~\nameref{sec:Basic Facilities of a Virtio Device / Driver notifications} for the definition of the components. } \hline
@@ -2123,7 +2123,7 @@ \subsubsection{Available Buffer Notifications}\label{sec:Virtio Transport Option the following 32-bit value to \field{QueueNotify}: \lstinputlisting{notifications-le.c} -See \ref{sec:Virtqueues / Driver notifications}~\nameref{sec:Virtqueues / Driver notifications} +See \ref{sec:Basic Facilities of a Virtio Device / Driver notifications}~\nameref{sec:Basic Facilities of a Virtio Device / Driver notifications} for the definition of the components. \subsubsection{Notifications From The Device}\label{sec:Virtio Transport Options / Virtio Over MMIO / MMIO-specific Initialization And Device Operation / Notifications From The Device}
@@ -2845,7 +2845,7 @@ \subsubsection{Guest->Host Notification}\label{sec:Virtio Transport Options / Vi the value has the following format: \lstinputlisting{notifications-be.c} -See \ref{sec:Virtqueues / Driver notifications}~\nameref{sec:Virtqueues / Driver notifications} +See \ref{sec:Basic Facilities of a Virtio Device / Driver notifications}~\nameref{sec:Basic Facilities of a Virtio Device / Driver notifications} for the definition of the components. \devicenormative{\paragraph}{Guest->Host Notification}{Virtio Transport Options / Virtio over channel I/O / Device Operation / Guest->Host Notification}
@@ -3091,12 +3091,12 @@ \chapter{Reserved Feature Bits}\label{sec:Reserved Feature Bits} \item[VIRTIO_F_NOTIFICATION_DATA(38)] This feature indicates that the driver passes extra data (besides identifying the virtqueue) in its device notifications. - See \ref{sec:Virtqueues / Driver notifications}~\nameref{sec:Virtqueues / Driver notifications}. + See \ref{sec:Basic Facilities of a Virtio Device / Driver notifications}~\nameref{sec:Basic Facilities of a Virtio Device / Driver notifications}. \item[VIRTIO_F_NOTIF_CONFIG_DATA(39)] This feature indicates that the driver uses the data provided by the device as a virtqueue identifier in available buffer notifications. - As mentioned in section \ref{sec:Virtqueues / Driver notifications}, when the + As mentioned in section \ref{sec:Basic Facilities of a Virtio Device / Driver notifications}, when the driver is required to send an available buffer notification to the device, it sends the virtqueue number to be notified. The method of delivering notifications is transport specific.
Signature · 1 line
2.26.2
Quoted 9 lines · Parav Pandit
Driver notifications section is under "Basic Facilities of a Virtio Device". However, the label is placed under "Virtqueues" section.
Fix the label references.
Signed-off-by Parav Pandit <[email protected]>--- content.tex | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)
Not sure if it was originally intended to sit unter the virtqueues section (it was lifted up one level as it disappeared under the packet ring section), might have been.
It probably makes sense to not try and move it back into the virtqueues section, and instead do your change. Other opinions?
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
Quoted 21 lines
From: Cornelia Huck <[email protected]>
Sent: Friday, February 10, 2023 6:23 AM
To: Parav Pandit <[email protected]>; [email protected]; virtio- [email protected]
Cc: [email protected]; Shahaf Shuler <[email protected]>; Parav Pandit <[email protected]>
Subject: Re: [PATCH] content.tex Fix Driver notifications labelQuoted 9 lines · Parav Pandit
Driver notifications section is under "Basic Facilities of a Virtio Device". However, the label is placed under "Virtqueues" section.
Fix the label references.
Signed-off-by Parav Pandit <[email protected]>--- content.tex | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)
Quoted 6 lines
Not sure if it was originally intended to sit unter the virtqueues section (it was lifted up one level as it disappeared under the packet ring section), might have been.
It probably makes sense to not try and move it back into the virtqueues section, and instead do your change. Other opinions?
If there is none, can you please proceed to complete the review? I assume this editorial fix doesn't need github issue.
Once this fix is in place, I would like to bring Notifications and driver Notifications sections close to each other as it has overlapping parts.
Michael S. Tsirkin
Acked-byQuoted 12 lines · Cornelia Huck
Quoted 9 lines · Parav Pandit
Driver notifications section is under "Basic Facilities of a Virtio Device". However, the label is placed under "Virtqueues" section.
Fix the label references.
Signed-off-by Parav Pandit <[email protected]>--- content.tex | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)
Quoted 6 lines
Not sure if it was originally intended to sit unter the virtqueues section (it was lifted up one level as it disappeared under the packet ring section), might have been.
It probably makes sense to not try and move it back into the virtqueues section, and instead do your change. Other opinions?
Minor fix does not need a vote.
Cornelia are you applying this?
Signature · 1 line
MST
Quoted 17 lines · Michael S. Tsirkin
Quoted 16 lines · Cornelia Huck
Quoted 9 lines · Parav Pandit
Driver notifications section is under "Basic Facilities of a Virtio Device". However, the label is placed under "Virtqueues" section.
Fix the label references.
Signed-off-by Parav Pandit <[email protected]>--- content.tex | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)Not sure if it was originally intended to sit unter the virtqueues section (it was lifted up one level as it disappeared under the packet ring section), might have been.
Quoted 7 lines
Quoted 2 lines
It probably makes sense to not try and move it back into the virtqueues section, and instead do your change. Other opinions?
Minor fix does not need a vote.
Cornelia are you applying this?
Pushed.
This publicly archived list offers a means to provide input to the OASIS Virtual I/O Device (VIRTIO) TC.
In order to verify user consent to the Feedback License terms and to minimize spam in the list archive, subscription is required before posting.
Subscribe: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/
Quoted 22 lines · Cornelia Huck
Quoted 20 lines · Michael S. Tsirkin
Quoted 18 lines · Cornelia Huck
Quoted 9 lines · Parav Pandit
Driver notifications section is under "Basic Facilities of a Virtio Device". However, the label is placed under "Virtqueues" section.
Fix the label references.
Signed-off-by Parav Pandit <[email protected]>--- content.tex | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)Not sure if it was originally intended to sit unter the virtqueues section (it was lifted up one level as it disappeared under the packet ring section), might have been.
It probably makes sense to not try and move it back into the virtqueues section, and instead do your change. Other opinions?
Quoted 6 lines
Quoted 4 lines
Minor fix does not need a vote.
Cornelia are you applying this?Pushed.
btw did you try to generate a diff pdf? when changing labels it is sometimes necessary to keep old ones around too as diff needs old and new links to work.
Signature · 1 line
MST
Quoted 25 lines · Michael S. Tsirkin
Quoted 24 lines · Cornelia Huck
Quoted 22 lines · Michael S. Tsirkin
Quoted 12 lines · Cornelia Huck
Quoted 9 lines · Parav Pandit
Driver notifications section is under "Basic Facilities of a Virtio Device". However, the label is placed under "Virtqueues" section.
Fix the label references.
Signed-off-by Parav Pandit <[email protected]>--- content.tex | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)Quoted 6 lines
Not sure if it was originally intended to sit unter the virtqueues section (it was lifted up one level as it disappeared under the packet ring section), might have been.
It probably makes sense to not try and move it back into the virtqueues section, and instead do your change. Other opinions?
Quoted 8 lines
Quoted 4 lines
Quoted 2 lines
Minor fix does not need a vote.
Cornelia are you applying this?Pushed.
btw did you try to generate a diff pdf? when changing labels it is sometimes necessary to keep old ones around too as diff needs old and new links to work.
I'm at least not seeing obvious errors.
This publicly archived list offers a means to provide input to the OASIS Virtual I/O Device (VIRTIO) TC.
In order to verify user consent to the Feedback License terms and to minimize spam in the list archive, subscription is required before posting.
Subscribe: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/
Quoted 6 lines
From: Michael S. Tsirkin <[email protected]>
Sent: Wednesday, February 15, 2023 8:00 AMbtw did you try to generate a diff pdf? when changing labels it is sometimes necessary to keep old ones around too as diff needs old and new links to work.
I generated the new pdf before pushing the patch. I couldn't generate the diff pdf using ./makediffpdf.sh
I get error on running makediff.sh virtio.tex
Warning: command \@chapapp containing @ found in
Warning: virtio.tex.
Warning: consider using --makeatletter if the result is not compilable.
Warning: command \@chapapp containing @ found in
Warning: ./main.tex.
Warning: consider using --makeatletter if the result is not compilable. Submodule path 'latexdiff' not initialized
Maybe you want to use 'update --init'?
make: Entering directory '/images/parav/upstream/virtio-spec/latexdiff'
make: *** No rule to make target 'mkdirs'. Stop.
make: Leaving directory '/images/parav/upstream/virtio-spec/latexdiff' ./makediff.sh: line 51: ./latexdiff-fast: No such file or directory
Quoted 12 lines · Parav Pandit
Quoted 6 lines
From: Michael S. Tsirkin <[email protected]>
Sent: Wednesday, February 15, 2023 8:00 AMbtw did you try to generate a diff pdf? when changing labels it is sometimes necessary to keep old ones around too as diff needs old and new links to work.
I generated the new pdf before pushing the patch. I couldn't generate the diff pdf using ./makediffpdf.sh
I get error on running
makediff.shvirtio.tex
Quoted 12 lines
Warning: command \@chapapp containing @ found in
Warning: virtio.tex.
Warning: consider using --makeatletter if the result is not compilable.
Warning: command \@chapapp containing @ found in
Warning: ./main.tex.
Warning: consider using --makeatletter if the result is not compilable. Submodule path 'latexdiff' not initialized
Maybe you want to use 'update --init'?
make: Entering directory '/images/parav/upstream/virtio-spec/latexdiff'
make: *** No rule to make target 'mkdirs'. Stop.
make: Leaving directory '/images/parav/upstream/virtio-spec/latexdiff' ./makediff.sh: line 51: ./latexdiff-fast: No such file or directory
Hmm. does this help:
makediff.sh +1 -1
@@ -44,7 +44,7 @@ latexpand $MAIN -o flat.tex cd "${cur}" #wget http://mirror.math.ku.edu/tex-archive/support/latexdiff/latexdiff-fast #chmod +x latexdiff-fast -git submodule update latexdiff +git submodule update --init latexdiff make -C latexdiff mkdirs dist/latexdiff-fast ln -fs ./latexdiff/dist/latexdiff-fast ./latexdiff-fast ./latexdiff-fast \
Quoted 32 lines
From: Michael S. Tsirkin <[email protected]>
Sent: Wednesday, February 15, 2023 7:20 PMQuoted 6 lines · Parav Pandit
Quoted 6 lines
From: Michael S. Tsirkin <[email protected]>
Sent: Wednesday, February 15, 2023 8:00 AMbtw did you try to generate a diff pdf? when changing labels it is sometimes necessary to keep old ones around too as diff needs old and
new links to work.
Quoted 6 lines
I generated the new pdf before pushing the patch. I couldn't generate the diff pdf using ./makediffpdf.sh
I get error on running
makediff.shvirtio.texQuoted 12 lines
Warning: command \@chapapp containing @ found in
Warning: virtio.tex.
Warning: consider using --makeatletter if the result is not compilable.
Warning: command \@chapapp containing @ found in
Warning: ./main.tex.
Warning: consider using --makeatletter if the result is not compilable. Submodule path 'latexdiff' not initialized Maybe you want to use 'update --init'?
make: Entering directory '/images/parav/upstream/virtio-spec/latexdiff'
make: *** No rule to make target 'mkdirs'. Stop.
make: Leaving directory '/images/parav/upstream/virtio-spec/latexdiff' ./makediff.sh: line 51: ./latexdiff-fast: No such file or directory
Quoted 2 lines
Hmm. does this help:
Works great. Thank you.
Was able to find out fixing the change log.
I posted the fix up patch at [1].
Please review.
[1] https://lists.oasis-open.org/archives/virtio-dev/202302/msg00331.html