Skip to contentSkip to conversation

content: Add link for the feature bits chapter

PATCH In review Parav Pandit 2 participants 5 messages Jun 11, 2024 – Jun 12, 2024

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 content: Add link for the feature bits chapter

Device common feature bits overview in the basic facilities and their actual description are apart by 24 chapters.

Help reader to directly reach out to feature bits definitions from the basic chapter.

---
 content.tex | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)
content.tex +4 -6
index 8849522..c3531e2 100644
@@ -97,12 +97,10 @@ \section{Feature Bits}\label{sec:Basic Facilities of a Virtio Device / Feature B
 Feature bits are allocated as follows:
 
 \begin{description}
-\item[0 to 23, and 50 to 127] Feature bits for the specific device type
-
-\item[24 to 41] Feature bits reserved for extensions to the queue and
-  feature negotiation mechanisms
-
-\item[42 to 49, and 128 and above] Feature bits reserved for future extensions.
+\item\textbf{0 to 23, and 50 to 127} Feature bits for the specific device type
+\item\textbf{\hyperref[sec:Reserved Feature Bits]{24 to 41}} Feature bits reserved for extensions
+to the queue and feature negotiation mechanisms
+\item\textbf{42 to 49, and 128 and above} Feature bits reserved for future extensions.
 \end{description}
 
 \begin{note}
Signature · 1 line
2.34.1
#1 lore raw
Quoted 20 lines · Parav Pandit

Device common feature bits overview in the basic facilities and their actual description are apart by 24 chapters.

Help reader to directly reach out to feature bits definitions from the basic chapter.

---
 content.tex | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)
content.tex +0 -1
index 8849522..c3531e2 100644
@@ -97,12 +97,10 @@ \section{Feature Bits}\label{sec:Basic Facilities of a Virtio Device / Feature B
 Feature bits are allocated as follows:
 
 \begin{description}
-\item[0 to 23, and 50 to 127] Feature bits for the specific device type

content.tex \section{Feature Bits}\label{sec:Basic Facilities of a Virtio Device / Feature B · line 104

Quoted 10 lines
content.tex +4 -5
-
-\item[24 to 41] Feature bits reserved for extensions to the queue and
-  feature negotiation mechanisms
-
-\item[42 to 49, and 128 and above] Feature bits reserved for future extensions.
+\item\textbf{0 to 23, and 50 to 127} Feature bits for the specific device type
+\item\textbf{\hyperref[sec:Reserved Feature Bits]{24 to 41}} Feature bits reserved for extensions
+to the queue and feature negotiation mechanisms
+\item\textbf{42 to 49, and 128 and above} Feature bits reserved for future extensions.
 \end{description}

Not everyone is browsing online, printing and reading should also work.
So no need to be cute, just add (see \ref[sec:Reserved Feature Bits]) or some such at the end of the sentence.

Quoted 3 lines
content.tex +0 -0
 \begin{note}
Signature · 1 line
2.34.1
#2 lore raw
Quoted 38 lines

From: Michael S. Tsirkin <[email protected]>
Sent: Wednesday, June 12, 2024 4:42 AM

Quoted 20 lines · Parav Pandit

Device common feature bits overview in the basic facilities and their actual description are apart by 24 chapters.

Help reader to directly reach out to feature bits definitions from the basic chapter.

---
 content.tex | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)
content.tex +0 -0
@@ -97,12 +97,10 @@ \section{Feature Bits}\label{sec:Basic Facilities

of a Virtio Device / Feature B Feature bits are allocated as follows:

\begin{description}
-\item[0 to 23, and 50 to 127] Feature bits for the specific device type

content.tex \section{Feature Bits}\label{sec:Basic Facilities of a Virtio Device / Feature B

Quoted 5 lines
content.tex +0 -5
-
-\item[24 to 41] Feature bits reserved for extensions to the queue and
-  feature negotiation mechanisms
-
-\item[42 to 49, and 128 and above] Feature bits reserved for future

extensions.

content.tex

Quoted 5 lines

+\item\textbf{0 to 23, and 50 to 127} Feature bits for the specific

content.tex +4 -0
+device type \item\textbf{\hyperref[sec:Reserved Feature Bits]{24 to
+41}} Feature bits reserved for extensions to the queue and feature
+negotiation mechanisms
+\item\textbf{42 to 49, and 128 and above} Feature bits reserved for future

extensions.

Quoted 5 lines
Quoted 1 line

\end{description}

Not everyone is browsing online, printing and reading should also work. So no need to be cute, just add (see \ref[sec:Reserved Feature Bits]) or some such at the end of the sentence.

Does hyperref break the printing and reading?
This didn't add any extra text for reference and reading in PDF was fine like before.

#3 lore raw
Quoted 38 lines · Parav Pandit
Quoted 38 lines

From: Michael S. Tsirkin <[email protected]>
Sent: Wednesday, June 12, 2024 4:42 AM

Quoted 20 lines · Parav Pandit

Device common feature bits overview in the basic facilities and their actual description are apart by 24 chapters.

Help reader to directly reach out to feature bits definitions from the basic chapter.

---
 content.tex | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)
content.tex +0 -0
@@ -97,12 +97,10 @@ \section{Feature Bits}\label{sec:Basic Facilities

of a Virtio Device / Feature B Feature bits are allocated as follows:

\begin{description}
-\item[0 to 23, and 50 to 127] Feature bits for the specific device type

content.tex \section{Feature Bits}\label{sec:Basic Facilities of a Virtio Device / Feature B

Quoted 5 lines
content.tex +0 -5
-
-\item[24 to 41] Feature bits reserved for extensions to the queue and
-  feature negotiation mechanisms
-
-\item[42 to 49, and 128 and above] Feature bits reserved for future

extensions.

content.tex

Quoted 5 lines

+\item\textbf{0 to 23, and 50 to 127} Feature bits for the specific

content.tex +4 -0
+device type \item\textbf{\hyperref[sec:Reserved Feature Bits]{24 to
+41}} Feature bits reserved for extensions to the queue and feature
+negotiation mechanisms
+\item\textbf{42 to 49, and 128 and above} Feature bits reserved for future

extensions.

Quoted 7 lines
Quoted 5 lines
Quoted 1 line

\end{description}

Not everyone is browsing online, printing and reading should also work. So no need to be cute, just add (see \ref[sec:Reserved Feature Bits]) or some such at the end of the sentence.

Does hyperref break the printing and reading?
This didn't add any extra text for reference and reading in PDF was fine like before.

It does not break it but it is not visible there - you are either saying the link is helpful - then it's helpful for everyone, or it's not needed then we don't need this change.

Just keep things simple and consistent please, we use \ref everywhere and hyperref for external links. The rule is broken in one place in scmi we should just fix that.

Signature · 1 line
MST
#4 lore raw
Quoted 54 lines

From: Michael S. Tsirkin <[email protected]>
Sent: Wednesday, June 12, 2024 11:11 AM

Quoted 17 lines · Parav Pandit
Quoted 17 lines

From: Michael S. Tsirkin <[email protected]>
Sent: Wednesday, June 12, 2024 4:42 AM

Quoted 11 lines · Parav Pandit

Device common feature bits overview in the basic facilities and their actual description are apart by 24 chapters.

Help reader to directly reach out to feature bits definitions from the basic chapter.

---
 content.tex | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
content.tex index 8849522..c3531e2 renamed from content.tex +0 -0

100644

content.tex +0 -0
@@ -97,12 +97,10 @@ \section{Feature Bits}\label{sec:Basic

Facilities of a Virtio Device / Feature B Feature bits are allocated as

follows:

Quoted 24 lines
Quoted 24 lines
Quoted 11 lines

\begin{description}
-\item[0 to 23, and 50 to 127] Feature bits for the specific device type
-
-\item[24 to 41] Feature bits reserved for extensions to the queue and

content.tex +0 -3
-  feature negotiation mechanisms
-
-\item[42 to 49, and 128 and above] Feature bits reserved for

future

extensions.

content.tex

Quoted 6 lines

+\item\textbf{0 to 23, and 50 to 127} Feature bits for the

content.tex +5 -0
+specific device type \item\textbf{\hyperref[sec:Reserved Feature
+Bits]{24 to 41}} Feature bits reserved for extensions to the
+queue and feature negotiation mechanisms
+\item\textbf{42 to 49, and 128 and above} Feature bits reserved
+for future

extensions.

Quoted 1 line

\end{description}

Not everyone is browsing online, printing and reading should also work. So no need to be cute, just add (see \ref[sec:Reserved Feature Bits]) or some such at the end of the sentence.

Quoted 8 lines
Quoted 2 lines

Does hyperref break the printing and reading?
This didn't add any extra text for reference and reading in PDF was fine like

before.

It does not break it but it is not visible there - you are either saying the link is helpful - then it's helpful for everyone, or it's not needed then we don't need this change.

I don't see how 'printing and reading' is linked to 'everyone' here. Anyways, I used the \ref as it is useful for navigation.