diff mbox

[ovs-dev] docs: Add link to man pages.

Message ID 20161213155704.17107-1-russell@ovn.org
State Not Applicable
Headers show

Commit Message

Russell Bryant Dec. 13, 2016, 3:57 p.m. UTC
Our new docs site does not yet include all of the man pages.  Add a link
to where they are currently hosted on openvswitch.org.

Signed-off-by: Russell Bryant <russell@ovn.org>
---
 Documentation/index.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Stephen Finucane Dec. 13, 2016, 6:17 p.m. UTC | #1
On Tue, 2016-12-13 at 10:57 -0500, Russell Bryant wrote:
> Our new docs site does not yet include all of the man pages.  Add a
> link
> to where they are currently hosted on openvswitch.org.

Working on it :)

> Signed-off-by: Russell Bryant <russell@ovn.org>
> ---
>  Documentation/index.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index f15993f..b2b1be9 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -61,7 +61,8 @@ vSwitch? Start here.
>  Deeper Dive
>  -----------
>  
> -**TODO**
> +Detailed man pages can be found on openvswitch.org
> +(http://openvswitch.org/support/dist-docs/).

Perhaps:

  `openvswitch.org <http://openvswitch.org/support/dist-docs/>`__

might be a little cleaner? That's a nit though, so...

Acked-by: Stephen Finucane <stephen@that.guru>
Stephen Finucane Dec. 13, 2016, 6:30 p.m. UTC | #2
On Tue, 2016-12-13 at 18:17 +0000, Stephen Finucane wrote:
> On Tue, 2016-12-13 at 10:57 -0500, Russell Bryant wrote:
> > Our new docs site does not yet include all of the man pages.  Add a
> > link
> > to where they are currently hosted on openvswitch.org.
> 
> Working on it :)
> 
> > Signed-off-by: Russell Bryant <russell@ovn.org>
> > ---
> >  Documentation/index.rst | 3 ++-
> >  1 file changed, 2 insertions(+), 1 deletion(-)
> > 
> > diff --git a/Documentation/index.rst b/Documentation/index.rst
> > index f15993f..b2b1be9 100644
> > --- a/Documentation/index.rst
> > +++ b/Documentation/index.rst
> > @@ -61,7 +61,8 @@ vSwitch? Start here.
> >  Deeper Dive
> >  -----------
> >  
> > -**TODO**
> > +Detailed man pages can be found on openvswitch.org
> > +(http://openvswitch.org/support/dist-docs/).
> 
> Perhaps:
> 
>   `openvswitch.org <http://openvswitch.org/support/dist-docs/>`__
> 
> might be a little cleaner? That's a nit though, so...

Actually - I already have this done in 'Documentation/ref/index.rst'
but forgot to include it anywhere. I'll submit a patch shortly to
resolve this.

Stephen
Russell Bryant Dec. 13, 2016, 8:09 p.m. UTC | #3
On Tue, Dec 13, 2016 at 1:30 PM, Stephen Finucane <stephen@that.guru> wrote:

> On Tue, 2016-12-13 at 18:17 +0000, Stephen Finucane wrote:
> > On Tue, 2016-12-13 at 10:57 -0500, Russell Bryant wrote:
> > > Our new docs site does not yet include all of the man pages.  Add a
> > > link
> > > to where they are currently hosted on openvswitch.org.
> >
> > Working on it :)
> >
> > > Signed-off-by: Russell Bryant <russell@ovn.org>
> > > ---
> > >  Documentation/index.rst | 3 ++-
> > >  1 file changed, 2 insertions(+), 1 deletion(-)
> > >
> > > diff --git a/Documentation/index.rst b/Documentation/index.rst
> > > index f15993f..b2b1be9 100644
> > > --- a/Documentation/index.rst
> > > +++ b/Documentation/index.rst
> > > @@ -61,7 +61,8 @@ vSwitch? Start here.
> > >  Deeper Dive
> > >  -----------
> > >
> > > -**TODO**
> > > +Detailed man pages can be found on openvswitch.org
> > > +(http://openvswitch.org/support/dist-docs/).
> >
> > Perhaps:
> >
> >   `openvswitch.org <http://openvswitch.org/support/dist-docs/>`__
> >
> > might be a little cleaner? That's a nit though, so...
>
> Actually - I already have this done in 'Documentation/ref/index.rst'
> but forgot to include it anywhere. I'll submit a patch shortly to
> resolve this.
>

OK, I'll just wait for your patch.
Stephen Finucane Dec. 14, 2016, 10:01 a.m. UTC | #4
On Tue, 2016-12-13 at 15:09 -0500, Russell Bryant wrote:
> 
> 
> On Tue, Dec 13, 2016 at 1:30 PM, Stephen Finucane <stephen@that.guru>
> wrote:
> > On Tue, 2016-12-13 at 18:17 +0000, Stephen Finucane wrote:
> > > On Tue, 2016-12-13 at 10:57 -0500, Russell Bryant wrote:
> > > > Our new docs site does not yet include all of the man
> > pages.  Add a
> > > > link
> > > > to where they are currently hosted on openvswitch.org.
> > >
> > > Working on it :)
> > >
> > > > Signed-off-by: Russell Bryant <russell@ovn.org>
> > > > ---
> > > >  Documentation/index.rst | 3 ++-
> > > >  1 file changed, 2 insertions(+), 1 deletion(-)
> > > >
> > > > diff --git a/Documentation/index.rst b/Documentation/index.rst
> > > > index f15993f..b2b1be9 100644
> > > > --- a/Documentation/index.rst
> > > > +++ b/Documentation/index.rst
> > > > @@ -61,7 +61,8 @@ vSwitch? Start here.
> > > >  Deeper Dive
> > > >  -----------
> > > >  
> > > > -**TODO**
> > > > +Detailed man pages can be found on openvswitch.org
> > > > +(http://openvswitch.org/support/dist-docs/).
> > >
> > > Perhaps:
> > >
> > >   `openvswitch.org <http://openvswitch.org/support/dist-docs/>`__
> > >
> > > might be a little cleaner? That's a nit though, so...
> > 
> > Actually - I already have this done in
> > 'Documentation/ref/index.rst'
> > but forgot to include it anywhere. I'll submit a patch shortly to
> > resolve this.
> 
> OK, I'll just wait for your patch.

Ben merged this yesterday

  mail.openvswitch.org/pipermail/ovs-dev/2016-December/326179.html

Stephen
Russell Bryant Dec. 16, 2016, 6:58 p.m. UTC | #5
On Wed, Dec 14, 2016 at 5:01 AM, Stephen Finucane <stephen@that.guru> wrote:

> On Tue, 2016-12-13 at 15:09 -0500, Russell Bryant wrote:
> >
> >
> > On Tue, Dec 13, 2016 at 1:30 PM, Stephen Finucane <stephen@that.guru>
> > wrote:
> > > On Tue, 2016-12-13 at 18:17 +0000, Stephen Finucane wrote:
> > > > On Tue, 2016-12-13 at 10:57 -0500, Russell Bryant wrote:
> > > > > Our new docs site does not yet include all of the man
> > > pages.  Add a
> > > > > link
> > > > > to where they are currently hosted on openvswitch.org.
> > > >
> > > > Working on it :)
> > > >
> > > > > Signed-off-by: Russell Bryant <russell@ovn.org>
> > > > > ---
> > > > >  Documentation/index.rst | 3 ++-
> > > > >  1 file changed, 2 insertions(+), 1 deletion(-)
> > > > >
> > > > > diff --git a/Documentation/index.rst b/Documentation/index.rst
> > > > > index f15993f..b2b1be9 100644
> > > > > --- a/Documentation/index.rst
> > > > > +++ b/Documentation/index.rst
> > > > > @@ -61,7 +61,8 @@ vSwitch? Start here.
> > > > >  Deeper Dive
> > > > >  -----------
> > > > >
> > > > > -**TODO**
> > > > > +Detailed man pages can be found on openvswitch.org
> > > > > +(http://openvswitch.org/support/dist-docs/).
> > > >
> > > > Perhaps:
> > > >
> > > >   `openvswitch.org <http://openvswitch.org/support/dist-docs/>`__
> > > >
> > > > might be a little cleaner? That's a nit though, so...
> > >
> > > Actually - I already have this done in
> > > 'Documentation/ref/index.rst'
> > > but forgot to include it anywhere. I'll submit a patch shortly to
> > > resolve this.
> >
> > OK, I'll just wait for your patch.
>
> Ben merged this yesterday
>
>   mail.openvswitch.org/pipermail/ovs-dev/2016-December/326179.html
>

Thanks, that looks nice and much better than what I had submitted.  :-)
diff mbox

Patch

diff --git a/Documentation/index.rst b/Documentation/index.rst
index f15993f..b2b1be9 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -61,7 +61,8 @@  vSwitch? Start here.
 Deeper Dive
 -----------
 
-**TODO**
+Detailed man pages can be found on openvswitch.org
+(http://openvswitch.org/support/dist-docs/).
 
 The Open vSwitch Project
 ------------------------