diff mbox

[ovs-dev] doc: Fix sphinx reference warning for windows.

Message ID 1493471323-8981-1-git-send-email-u9012063@gmail.com
State Accepted
Headers show

Commit Message

William Tu April 29, 2017, 1:08 p.m. UTC
Footnote reference 5, 8, and 9 are not referenced in the windws.rst content,
causing the following error:
Warning, treated as error:
/root/ovs/Documentation/topics/windows.rst:506:Footnote [5] is not referenced.

Signed-off-by: William Tu <u9012063@gmail.com>
---
 Documentation/topics/windows.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Numan Siddique May 31, 2017, 4:16 p.m. UTC | #1
Hi Ben,

Can this commit [1]  be backported to OVS 2.7 please. networking-ovn CI job
is failing to compile OVS 2.7 with sphinx version 1.6.2 (CI job is using
sphinx version 1.6.2).

With this commit, it works fine.

[1] -
https://github.com/openvswitch/ovs/commit/01f92b743eb334d09bdeb511bf7d35e88a5e70f8

Thanks
Numan


On Sat, Apr 29, 2017 at 6:38 PM, William Tu <u9012063@gmail.com> wrote:

> Footnote reference 5, 8, and 9 are not referenced in the windws.rst
> content,
> causing the following error:
> Warning, treated as error:
> /root/ovs/Documentation/topics/windows.rst:506:Footnote [5] is not
> referenced.
>
> Signed-off-by: William Tu <u9012063@gmail.com>
> ---
>  Documentation/topics/windows.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/topics/windows.rst b/Documentation/topics/
> windows.rst
> index 6d7158ebfd77..3a103b4e8983 100644
> --- a/Documentation/topics/windows.rst
> +++ b/Documentation/topics/windows.rst
> @@ -68,7 +68,7 @@ port. The workflow for the calls is similar in nature to
> the packets, where
>  higher level layers call into the lower level layers. A good
> representational
>  diagram of this architecture is in [4]_.
>
> -Windows Filtering Platform (WFP)[5]_ is a platform implemented on Hyper-V
> that
> +Windows Filtering Platform (WFP) [5]_ is a platform implemented on
> Hyper-V that
>  provides APIs and services for filtering packets. WFP has been utilized to
>  filter on some of the packets that OVS is not equipped to handle
> directly. More
>  details in later sections.
> @@ -253,7 +253,7 @@ Netlink Message Parser
>  ~~~~~~~~~~~~~~~~~~~~~~
>
>  The communication between OVS userspace and OVS kernel datapath is in the
> form
> -of Netlink messages [1]_. More details about this are provided below.  In
> the
> +of Netlink messages [1]_, [8]_. More details about this are provided
> below.  In the
>  kernel, a full fledged netlink message parser has been implemented along
> the
>  lines of the netlink message parser in OVS userspace. In fact, a lot of
> the
>  code is ported code.
> @@ -407,7 +407,7 @@ As has been mentioned in earlier sections, the netlink
> socket and netlink
>  message based DPIF provider on Linux has been ported to Windows.
>
>  Most of the code is common. Some divergence is in the code to receive
> packets.
> -The Linux implementation uses epoll() which is not natively supported on
> +The Linux implementation uses epoll() [9]_ which is not natively
> supported on
>  Windows.
>
>  netdev-windows
> --
> 2.7.4
>
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>
Ben Pfaff May 31, 2017, 7:02 p.m. UTC | #2
Done!  Thanks for the suggestion.

On Wed, May 31, 2017 at 09:46:06PM +0530, Numan Siddique wrote:
> Hi Ben,
> 
> Can this commit [1]  be backported to OVS 2.7 please. networking-ovn CI job
> is failing to compile OVS 2.7 with sphinx version 1.6.2 (CI job is using
> sphinx version 1.6.2).
> 
> With this commit, it works fine.
> 
> [1] -
> https://github.com/openvswitch/ovs/commit/01f92b743eb334d09bdeb511bf7d35e88a5e70f8
> 
> Thanks
> Numan
> 
> 
> On Sat, Apr 29, 2017 at 6:38 PM, William Tu <u9012063@gmail.com> wrote:
> 
> > Footnote reference 5, 8, and 9 are not referenced in the windws.rst
> > content,
> > causing the following error:
> > Warning, treated as error:
> > /root/ovs/Documentation/topics/windows.rst:506:Footnote [5] is not
> > referenced.
> >
> > Signed-off-by: William Tu <u9012063@gmail.com>
> > ---
> >  Documentation/topics/windows.rst | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> >
> > diff --git a/Documentation/topics/windows.rst b/Documentation/topics/
> > windows.rst
> > index 6d7158ebfd77..3a103b4e8983 100644
> > --- a/Documentation/topics/windows.rst
> > +++ b/Documentation/topics/windows.rst
> > @@ -68,7 +68,7 @@ port. The workflow for the calls is similar in nature to
> > the packets, where
> >  higher level layers call into the lower level layers. A good
> > representational
> >  diagram of this architecture is in [4]_.
> >
> > -Windows Filtering Platform (WFP)[5]_ is a platform implemented on Hyper-V
> > that
> > +Windows Filtering Platform (WFP) [5]_ is a platform implemented on
> > Hyper-V that
> >  provides APIs and services for filtering packets. WFP has been utilized to
> >  filter on some of the packets that OVS is not equipped to handle
> > directly. More
> >  details in later sections.
> > @@ -253,7 +253,7 @@ Netlink Message Parser
> >  ~~~~~~~~~~~~~~~~~~~~~~
> >
> >  The communication between OVS userspace and OVS kernel datapath is in the
> > form
> > -of Netlink messages [1]_. More details about this are provided below.  In
> > the
> > +of Netlink messages [1]_, [8]_. More details about this are provided
> > below.  In the
> >  kernel, a full fledged netlink message parser has been implemented along
> > the
> >  lines of the netlink message parser in OVS userspace. In fact, a lot of
> > the
> >  code is ported code.
> > @@ -407,7 +407,7 @@ As has been mentioned in earlier sections, the netlink
> > socket and netlink
> >  message based DPIF provider on Linux has been ported to Windows.
> >
> >  Most of the code is common. Some divergence is in the code to receive
> > packets.
> > -The Linux implementation uses epoll() which is not natively supported on
> > +The Linux implementation uses epoll() [9]_ which is not natively
> > supported on
> >  Windows.
> >
> >  netdev-windows
> > --
> > 2.7.4
> >
> > _______________________________________________
> > dev mailing list
> > dev@openvswitch.org
> > https://mail.openvswitch.org/mailman/listinfo/ovs-dev
> >
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
diff mbox

Patch

diff --git a/Documentation/topics/windows.rst b/Documentation/topics/windows.rst
index 6d7158ebfd77..3a103b4e8983 100644
--- a/Documentation/topics/windows.rst
+++ b/Documentation/topics/windows.rst
@@ -68,7 +68,7 @@  port. The workflow for the calls is similar in nature to the packets, where
 higher level layers call into the lower level layers. A good representational
 diagram of this architecture is in [4]_.
 
-Windows Filtering Platform (WFP)[5]_ is a platform implemented on Hyper-V that
+Windows Filtering Platform (WFP) [5]_ is a platform implemented on Hyper-V that
 provides APIs and services for filtering packets. WFP has been utilized to
 filter on some of the packets that OVS is not equipped to handle directly. More
 details in later sections.
@@ -253,7 +253,7 @@  Netlink Message Parser
 ~~~~~~~~~~~~~~~~~~~~~~
 
 The communication between OVS userspace and OVS kernel datapath is in the form
-of Netlink messages [1]_. More details about this are provided below.  In the
+of Netlink messages [1]_, [8]_. More details about this are provided below.  In the
 kernel, a full fledged netlink message parser has been implemented along the
 lines of the netlink message parser in OVS userspace. In fact, a lot of the
 code is ported code.
@@ -407,7 +407,7 @@  As has been mentioned in earlier sections, the netlink socket and netlink
 message based DPIF provider on Linux has been ported to Windows.
 
 Most of the code is common. Some divergence is in the code to receive packets.
-The Linux implementation uses epoll() which is not natively supported on
+The Linux implementation uses epoll() [9]_ which is not natively supported on
 Windows.
 
 netdev-windows