[PATCH] content: Remove duplicate paragraph

[PATCH] content: Remove duplicate paragraph

[Jean-Philippe Brucker]

It looks like commit 356aeeb40d7a ("content: add vendor specific cfg
type") had a merge issue. It includes the device normative paragraph for
Shared memory capability, which was already added right above it by
commit 855ad7af2bd6 ("shared memory: Define PCI capability"). Remove the
duplicate paragraph.

Signed-off-by: Jean-Philippe Brucker <jean-philippe@linaro.org>
---
This applies onto "Fix copy/paste bug in PCI transport paragraph", that
fixes both paragraph titles.
https://lists.oasis-open.org/archives/virtio-comment/202108/msg00097.html
---
 content.tex | 8 --------
 1 file changed, 8 deletions(-)

diff --git a/content.tex b/content.tex
index 4418ac8..54f7441 100644
--- a/content.tex
+++ b/content.tex
@@ -1149,14 +1149,6 @@ \subsubsection{Shared memory capability}\label{sec:Virtio Transport Options / Vi
 
 The \field{cap.id} MUST be unique for any one device instance.
 
-\devicenormative{\paragraph}{Shared memory capability}{Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Shared memory capability}
-
-The region defined by the combination of the \field {cap.offset},
-\field {cap.offset_hi}, and \field {cap.length}, \field
-{cap.length_hi} fields MUST be contained within the declared bar.
-
-The \field{cap.id} MUST be unique for any one device instance.
-
 \subsubsection{Vendor data capability}\label{sec:Virtio
 Transport Options / Virtio Over PCI Bus / PCI Device Layout /
 Vendor data capability}
-- 
2.33.0

Re: [virtio-dev] [PATCH] content: Remove duplicate paragraph

[Stefan Hajnoczi]

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

On Thu, Sep 30, 2021 at 01:58:48PM +0100, Jean-Philippe Brucker wrote:
> It looks like commit 356aeeb40d7a ("content: add vendor specific cfg
> type") had a merge issue. It includes the device normative paragraph for
> Shared memory capability, which was already added right above it by
> commit 855ad7af2bd6 ("shared memory: Define PCI capability"). Remove the
> duplicate paragraph.
> 
> Signed-off-by: Jean-Philippe Brucker <jean-philippe@linaro.org>
> ---
> This applies onto "Fix copy/paste bug in PCI transport paragraph", that
> fixes both paragraph titles.
> https://lists.oasis-open.org/archives/virtio-comment/202108/msg00097.html
> ---
>  content.tex | 8 --------
>  1 file changed, 8 deletions(-)

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

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

Re: [PATCH] content: Remove duplicate paragraph

[Michael S. Tsirkin]

On Thu, Sep 30, 2021 at 01:58:48PM +0100, Jean-Philippe Brucker wrote:
> It looks like commit 356aeeb40d7a ("content: add vendor specific cfg
> type") had a merge issue. It includes the device normative paragraph for
> Shared memory capability, which was already added right above it by
> commit 855ad7af2bd6 ("shared memory: Define PCI capability"). Remove the
> duplicate paragraph.
> 
> Signed-off-by: Jean-Philippe Brucker <jean-philippe@linaro.org>


Acked-by: Michael S. Tsirkin <mst@redhat.com>

Cornelia, I think this can go in under the trivial fixes rule.

> ---
> This applies onto "Fix copy/paste bug in PCI transport paragraph", that
> fixes both paragraph titles.
> https://lists.oasis-open.org/archives/virtio-comment/202108/msg00097.html
> ---
>  content.tex | 8 --------
>  1 file changed, 8 deletions(-)
> 
> diff --git a/content.tex b/content.tex
> index 4418ac8..54f7441 100644
> --- a/content.tex
> +++ b/content.tex
> @@ -1149,14 +1149,6 @@ \subsubsection{Shared memory capability}\label{sec:Virtio Transport Options / Vi
>  
>  The \field{cap.id} MUST be unique for any one device instance.
>  
> -\devicenormative{\paragraph}{Shared memory capability}{Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Shared memory capability}
> -
> -The region defined by the combination of the \field {cap.offset},
> -\field {cap.offset_hi}, and \field {cap.length}, \field
> -{cap.length_hi} fields MUST be contained within the declared bar.
> -
> -The \field{cap.id} MUST be unique for any one device instance.
> -
>  \subsubsection{Vendor data capability}\label{sec:Virtio
>  Transport Options / Virtio Over PCI Bus / PCI Device Layout /
>  Vendor data capability}
> -- 
> 2.33.0

[virtio-dev] Re: [PATCH] content: Remove duplicate paragraph

[Cornelia Huck]

On Thu, Sep 30 2021, Jean-Philippe Brucker <jean-philippe@linaro.org> wrote:

> It looks like commit 356aeeb40d7a ("content: add vendor specific cfg
> type") had a merge issue. It includes the device normative paragraph for
> Shared memory capability, which was already added right above it by
> commit 855ad7af2bd6 ("shared memory: Define PCI capability"). Remove the
> duplicate paragraph.
>
> Signed-off-by: Jean-Philippe Brucker <jean-philippe@linaro.org>
> ---
> This applies onto "Fix copy/paste bug in PCI transport paragraph", that
> fixes both paragraph titles.
> https://lists.oasis-open.org/archives/virtio-comment/202108/msg00097.html
> ---
>  content.tex | 8 --------
>  1 file changed, 8 deletions(-)
>
> diff --git a/content.tex b/content.tex
> index 4418ac8..54f7441 100644
> --- a/content.tex
> +++ b/content.tex
> @@ -1149,14 +1149,6 @@ \subsubsection{Shared memory capability}\label{sec:Virtio Transport Options / Vi
>  
>  The \field{cap.id} MUST be unique for any one device instance.
>  
> -\devicenormative{\paragraph}{Shared memory capability}{Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Shared memory capability}
> -
> -The region defined by the combination of the \field {cap.offset},
> -\field {cap.offset_hi}, and \field {cap.length}, \field
> -{cap.length_hi} fields MUST be contained within the declared bar.
> -
> -The \field{cap.id} MUST be unique for any one device instance.
> -
>  \subsubsection{Vendor data capability}\label{sec:Virtio
>  Transport Options / Virtio Over PCI Bus / PCI Device Layout /
>  Vendor data capability}

Hm. This statement is indeed included twice, but the two are not exactly
the same. For the first paragraph, do we want to use a combination of
the two? IOW, something like

"The region defined by the combination of the \field {cap.offset},
\field {cap.offset_hi}, and \field {cap.length}, \field
{cap.length_hi} fields MUST be contained within the BAR specified by
\field{cap.bar}."


---------------------------------------------------------------------
To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org

Re: [PATCH] content: Remove duplicate paragraph

[Jean-Philippe Brucker]

On Mon, Oct 04, 2021 at 12:56:48PM +0200, Cornelia Huck wrote:
> On Thu, Sep 30 2021, Jean-Philippe Brucker <jean-philippe@linaro.org> wrote:
> 
> > It looks like commit 356aeeb40d7a ("content: add vendor specific cfg
> > type") had a merge issue. It includes the device normative paragraph for
> > Shared memory capability, which was already added right above it by
> > commit 855ad7af2bd6 ("shared memory: Define PCI capability"). Remove the
> > duplicate paragraph.
> >
> > Signed-off-by: Jean-Philippe Brucker <jean-philippe@linaro.org>
> > ---
> > This applies onto "Fix copy/paste bug in PCI transport paragraph", that
> > fixes both paragraph titles.
> > https://lists.oasis-open.org/archives/virtio-comment/202108/msg00097.html
> > ---
> >  content.tex | 8 --------
> >  1 file changed, 8 deletions(-)
> >
> > diff --git a/content.tex b/content.tex
> > index 4418ac8..54f7441 100644
> > --- a/content.tex
> > +++ b/content.tex
> > @@ -1149,14 +1149,6 @@ \subsubsection{Shared memory capability}\label{sec:Virtio Transport Options / Vi
> >  
> >  The \field{cap.id} MUST be unique for any one device instance.
> >  
> > -\devicenormative{\paragraph}{Shared memory capability}{Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Shared memory capability}
> > -
> > -The region defined by the combination of the \field {cap.offset},
> > -\field {cap.offset_hi}, and \field {cap.length}, \field
> > -{cap.length_hi} fields MUST be contained within the declared bar.
> > -
> > -The \field{cap.id} MUST be unique for any one device instance.
> > -
> >  \subsubsection{Vendor data capability}\label{sec:Virtio
> >  Transport Options / Virtio Over PCI Bus / PCI Device Layout /
> >  Vendor data capability}
> 
> Hm. This statement is indeed included twice, but the two are not exactly
> the same. For the first paragraph, do we want to use a combination of
> the two? IOW, something like
> 
> "The region defined by the combination of the \field {cap.offset},
> \field {cap.offset_hi}, and \field {cap.length}, \field
> {cap.length_hi} fields MUST be contained within the BAR specified by
> \field{cap.bar}."
> 

Makes sense, although thinking more about this it was the first paragraph
that was correct, because it refers to:

  struct virtio_pci_cap64 {
    struct virtio_pci_cap {
      ...
      le32 offset;
      le32 length;
    } cap;
    u32 offset_hi;
    u32 length_hi;
  }

So it would be \field{cap.offset} and \field{offset_hi}.
I'll send a v2

Thanks,
Jean