From: "Mcnamara, John" <john.mcnamara@intel.com>
To: "Lipiec, Herakliusz" <herakliusz.lipiec@intel.com>,
"Richardson, Bruce" <bruce.richardson@intel.com>,
"Medvedkin, Vladimir" <vladimir.medvedkin@intel.com>,
"Kovacevic, Marko" <marko.kovacevic@intel.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>,
"Iremonger, Bernard" <bernard.iremonger@intel.com>,
"stable@dpdk.org" <stable@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH] doc: fix broken link in programmers guide lpm library references
Date: Wed, 1 May 2019 14:12:37 +0000 [thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE23F60A1EE@IRSMSX103.ger.corp.intel.com> (raw)
Message-ID: <20190501141237.3lbMwXCOiunjNuRuzSai2W-pMZEbnBHwpYmIcRqzB7w@z> (raw)
In-Reply-To: <20190424153536.26122-1-herakliusz.lipiec@intel.com>
> -----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>
next prev parent reply other threads:[~2019-05-01 14:12 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-24 15:35 Herakliusz Lipiec
2019-04-24 15:35 ` Herakliusz Lipiec
2019-04-24 18:52 ` Rami Rosen
2019-04-24 18:52 ` Rami Rosen
2019-04-25 10:21 ` Medvedkin, Vladimir
2019-04-25 10:21 ` Medvedkin, Vladimir
2019-05-01 14:12 ` Mcnamara, John [this message]
2019-05-01 14:12 ` Mcnamara, John
2019-05-04 21:41 ` Thomas Monjalon
2019-05-04 21:41 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=B27915DBBA3421428155699D51E4CFE23F60A1EE@IRSMSX103.ger.corp.intel.com \
--to=john.mcnamara@intel.com \
--cc=bernard.iremonger@intel.com \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=herakliusz.lipiec@intel.com \
--cc=marko.kovacevic@intel.com \
--cc=stable@dpdk.org \
--cc=vladimir.medvedkin@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).