[PATCH] content: Add link for the feature bits chapter

[PATCH] content: Add link for the feature bits chapter

[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.

Signed-off-by: Parav Pandit <parav@nvidia.com>
---
 content.tex | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)

diff --git a/content.tex b/content.tex
index 8849522..c3531e2 100644
--- a/content.tex
+++ b/content.tex
@@ -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}
-- 
2.34.1

Re: [PATCH] content: Add link for the feature bits chapter

[Michael S. Tsirkin]

On Tue, Jun 11, 2024 at 08:57:21PM +0300, Parav Pandit wrote:
> 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.
> 
> Signed-off-by: Parav Pandit <parav@nvidia.com>
> ---
>  content.tex | 10 ++++------
>  1 file changed, 4 insertions(+), 6 deletions(-)
> 
> diff --git a/content.tex b/content.tex
> index 8849522..c3531e2 100644
> --- a/content.tex
> +++ b/content.tex
> @@ -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}

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.


>  \begin{note}
> -- 
> 2.34.1

RE: [PATCH] content: Add link for the feature bits chapter

[Parav Pandit]

> From: Michael S. Tsirkin <mst@redhat.com>
> Sent: Wednesday, June 12, 2024 4:42 AM
> 
> On Tue, Jun 11, 2024 at 08:57:21PM +0300, Parav Pandit wrote:
> > 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.
> >
> > Signed-off-by: Parav Pandit <parav@nvidia.com>
> > ---
> >  content.tex | 10 ++++------
> >  1 file changed, 4 insertions(+), 6 deletions(-)
> >
> > diff --git a/content.tex b/content.tex index 8849522..c3531e2 100644
> > --- a/content.tex
> > +++ b/content.tex
> > @@ -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}
> 
> 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.

Re: [PATCH] content: Add link for the feature bits chapter

[Michael S. Tsirkin]

On Wed, Jun 12, 2024 at 03:51:48AM +0000, Parav Pandit wrote:
> 
> 
> > From: Michael S. Tsirkin <mst@redhat.com>
> > Sent: Wednesday, June 12, 2024 4:42 AM
> > 
> > On Tue, Jun 11, 2024 at 08:57:21PM +0300, Parav Pandit wrote:
> > > 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.
> > >
> > > Signed-off-by: Parav Pandit <parav@nvidia.com>
> > > ---
> > >  content.tex | 10 ++++------
> > >  1 file changed, 4 insertions(+), 6 deletions(-)
> > >
> > > diff --git a/content.tex b/content.tex index 8849522..c3531e2 100644
> > > --- a/content.tex
> > > +++ b/content.tex
> > > @@ -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}
> > 
> > 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.

-- 
MST

RE: [PATCH] content: Add link for the feature bits chapter

[Parav Pandit]

> From: Michael S. Tsirkin <mst@redhat.com>
> Sent: Wednesday, June 12, 2024 11:11 AM
> 
> On Wed, Jun 12, 2024 at 03:51:48AM +0000, Parav Pandit wrote:
> >
> >
> > > From: Michael S. Tsirkin <mst@redhat.com>
> > > Sent: Wednesday, June 12, 2024 4:42 AM
> > >
> > > On Tue, Jun 11, 2024 at 08:57:21PM +0300, Parav Pandit wrote:
> > > > 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.
> > > >
> > > > Signed-off-by: Parav Pandit <parav@nvidia.com>
> > > > ---
> > > >  content.tex | 10 ++++------
> > > >  1 file changed, 4 insertions(+), 6 deletions(-)
> > > >
> > > > diff --git a/content.tex b/content.tex index 8849522..c3531e2
> > > > 100644
> > > > --- a/content.tex
> > > > +++ b/content.tex
> > > > @@ -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}
> > >
> > > 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.
>
I don't see how 'printing and reading' is linked to 'everyone' here.
Anyways, I used the \ref as it is useful for navigation.