diff mbox series

doc: fix broken link in programmers guide lpm library references

Message ID 20190424153536.26122-1-herakliusz.lipiec@intel.com (mailing list archive)
State Accepted, archived
Headers show
Series doc: fix broken link in programmers guide lpm library references | expand

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Lipiec, Herakliusz April 24, 2019, 3:35 p.m. UTC
Bugzilla ID: 235
Fixes: fc1f2750a3ec ("doc: programmers guide")
Cc: bernard.iremonger@intel.com
Cc: stable@dpdk.org
Signed-off-by: Herakliusz Lipiec <herakliusz.lipiec@intel.com>
---
 doc/guides/prog_guide/lpm_lib.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Rami Rosen April 24, 2019, 6:52 p.m. UTC | #1
Acked-by: Rami Rosen <ramirose@gmail.com>
Vladimir Medvedkin April 25, 2019, 10:21 a.m. UTC | #2
Acked-by: Vladimir Medvedkin <vladimir.medvedkin@intel.com>

On 24/04/2019 16:35, Herakliusz Lipiec wrote:
> Bugzilla ID: 235
> Fixes: fc1f2750a3ec ("doc: programmers guide")
> Cc: bernard.iremonger@intel.com
> Cc: stable@dpdk.org
> Signed-off-by: Herakliusz Lipiec <herakliusz.lipiec@intel.com>
> ---
>   doc/guides/prog_guide/lpm_lib.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/doc/guides/prog_guide/lpm_lib.rst b/doc/guides/prog_guide/lpm_lib.rst
> index 99563a4a6..1609a57d0 100644
> --- a/doc/guides/prog_guide/lpm_lib.rst
> +++ b/doc/guides/prog_guide/lpm_lib.rst
> @@ -195,4 +195,4 @@ References
>       `http://www.ietf.org/rfc/rfc1519 <http://www.ietf.org/rfc/rfc1519>`_
>   
>   *   Pankaj Gupta, Algorithms for Routing Lookups and Packet Classification, PhD Thesis, Stanford University,
> -    2000  (`http://klamath.stanford.edu/~pankaj/thesis/ thesis_1sided.pdf <http://klamath.stanford.edu/~pankaj/thesis/%20thesis_1sided.pdf>`_ )
> +    2000  (`http://klamath.stanford.edu/~pankaj/thesis/thesis_1sided.pdf <http://klamath.stanford.edu/~pankaj/thesis/thesis_1sided.pdf>`_ )
Mcnamara, John May 1, 2019, 2:12 p.m. UTC | #3
> -----Original Message-----
> From: Lipiec, Herakliusz
> Sent: Wednesday, April 24, 2019 4:36 PM
> To: Richardson, Bruce <bruce.richardson@intel.com>; Medvedkin, Vladimir
> <vladimir.medvedkin@intel.com>; Mcnamara, John <john.mcnamara@intel.com>;
> Kovacevic, Marko <marko.kovacevic@intel.com>
> Cc: dev@dpdk.org; Lipiec, Herakliusz <herakliusz.lipiec@intel.com>;
> Iremonger, Bernard <bernard.iremonger@intel.com>; stable@dpdk.org
> Subject: [PATCH] doc: fix broken link in programmers guide lpm library
> references
> 
> Bugzilla ID: 235

The fix is good and should be applied.

However, if viewed strictly, that `Link text <https://url/>`_ syntax is only required if the link text and the url are different.

So in this case you could (or the original author) just use a simple url without any additional syntax.

However, better still would be if we did something like this to put the links inline in the text:

diff --git a/doc/guides/prog_guide/lpm_lib.rst b/doc/guides/prog_guide/lpm_lib.rst
index 99563a4..375e666 100644
--- a/doc/guides/prog_guide/lpm_lib.rst
+++ b/doc/guides/prog_guide/lpm_lib.rst
@@ -191,8 +191,10 @@ The LPM algorithm is used to implement Classless Inter-Domain Routing (CIDR) str
 References
 ~~~~~~~~~~
 
-*   RFC1519 Classless Inter-Domain Routing (CIDR): an Address Assignment and Aggregation Strategy,
-    `http://www.ietf.org/rfc/rfc1519 <http://www.ietf.org/rfc/rfc1519>`_
+* `RFC1519 <http://www.ietf.org/rfc/rfc1519>`_ Classless Inter-Domain Routing
+  (CIDR): an Address Assignment and Aggregation Strategy.
 
-*   Pankaj Gupta, Algorithms for Routing Lookups and Packet Classification, PhD Thesis, Stanford University,
-    2000  (`http://klamath.stanford.edu/~pankaj/thesis/ thesis_1sided.pdf <http://klamath.stanford.edu/~pankaj/thesis/%20thesis_1sided.pdf>`_ )
+
+* Pankaj Gupta, `Algorithms for Routing Lookups and Packet Classification
+  <http://klamath.stanford.edu/~pankaj/thesis/thesis_1sided.pdf>`_, PhD
+  Thesis, Stanford University, 2000.

However, the fix is better than a broken link so:

Acked-by: John McNamara <john.mcnamara@intel.com>
Thomas Monjalon May 4, 2019, 9:41 p.m. UTC | #4
01/05/2019 16:12, Mcnamara, John:
> From: Lipiec, Herakliusz
> > 
> > Bugzilla ID: 235
> 
> The fix is good and should be applied.
> 
> However, if viewed strictly, that `Link text <https://url/>`_ syntax is only required if the link text and the url are different.
> 
> So in this case you could (or the original author) just use a simple url without any additional syntax.
> 
> However, better still would be if we did something like this to put the links inline in the text:

Yes, that would be good to do this kind of cleanup in the guides.

[...]
> However, the fix is better than a broken link so:
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/lpm_lib.rst b/doc/guides/prog_guide/lpm_lib.rst
index 99563a4a6..1609a57d0 100644
--- a/doc/guides/prog_guide/lpm_lib.rst
+++ b/doc/guides/prog_guide/lpm_lib.rst
@@ -195,4 +195,4 @@  References
     `http://www.ietf.org/rfc/rfc1519 <http://www.ietf.org/rfc/rfc1519>`_
 
 *   Pankaj Gupta, Algorithms for Routing Lookups and Packet Classification, PhD Thesis, Stanford University,
-    2000  (`http://klamath.stanford.edu/~pankaj/thesis/ thesis_1sided.pdf <http://klamath.stanford.edu/~pankaj/thesis/%20thesis_1sided.pdf>`_ )
+    2000  (`http://klamath.stanford.edu/~pankaj/thesis/thesis_1sided.pdf <http://klamath.stanford.edu/~pankaj/thesis/thesis_1sided.pdf>`_ )