[spp] [PATCH 0/2] Update doc for inappropriate link

[spp] [PATCH 0/2] Update doc for inappropriate link

[ogawa.yasufumi]

From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>

In howto use guide, link for command manual is described as url.
However, it is not appropriate because the url of hosting site can
be changed and it should be described as a relative path. This update
is to add a label to be reffered from howto guide and replace the
link.

Yasufumi Ogawa (2):
  docs: add label to index of command reference
  docs: update link of command reference

 docs/guides/commands/index.rst  | 2 ++
 docs/guides/setup/howto_use.rst | 3 +--
 2 files changed, 3 insertions(+), 2 deletions(-)

-- 
2.17.1

[spp] [PATCH 1/2] docs: add label to index of command reference

[ogawa.yasufumi]

From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>

Add a label to index of command reference to be referred from
other documents.

Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
 docs/guides/commands/index.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/docs/guides/commands/index.rst b/docs/guides/commands/index.rst
index a8574b6..f4fa983 100644
--- a/docs/guides/commands/index.rst
+++ b/docs/guides/commands/index.rst
@@ -1,3 +1,5 @@
+.. _spp_command_index:
+
 ..  BSD LICENSE
     Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
     All rights reserved.
-- 
2.17.1

[spp] [PATCH 2/2] docs: update link of command reference

[ogawa.yasufumi]

From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>

In 'How to Use' section, link for SPP command reference refers to
the url of readthedocs. However, it might be changed in future.
This update is to change the link from url to relative path to avoid
not found error.

Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
 docs/guides/setup/howto_use.rst | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/docs/guides/setup/howto_use.rst b/docs/guides/setup/howto_use.rst
index dc014aa..8ad0c27 100644
--- a/docs/guides/setup/howto_use.rst
+++ b/docs/guides/setup/howto_use.rst
@@ -83,8 +83,7 @@ Please refer help message for options.
       -ip IPADDR, --ipaddr IPADDR
                             IP address
 
-`SPP commands
-<http://spp.readthedocs.io/en/doc_rst/commands/index.html>`_ describes
+:doc:`../../commands/index` describes
 how to manage SPP processes from SPP controller.
 
 
-- 
2.17.1

Re: [spp] [PATCH 0/2] Update doc for inappropriate link

[Ferruh Yigit]

On 6/15/2018 8:02 AM, ogawa.yasufumi@lab.ntt.co.jp wrote:
> From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
> 
> In howto use guide, link for command manual is described as url.
> However, it is not appropriate because the url of hosting site can
> be changed and it should be described as a relative path. This update
> is to add a label to be reffered from howto guide and replace the
> link.
> 
> Yasufumi Ogawa (2):
>   docs: add label to index of command reference
>   docs: update link of command reference

Series applied, thanks.