From patchwork Tue Nov 8 10:02:38 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Monjalon X-Patchwork-Id: 16977 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id ACB8BB62; Tue, 8 Nov 2016 11:03:00 +0100 (CET) Received: from mail-wm0-f54.google.com (mail-wm0-f54.google.com [74.125.82.54]) by dpdk.org (Postfix) with ESMTP id 486EFA2F for ; Tue, 8 Nov 2016 11:02:58 +0100 (CET) Received: by mail-wm0-f54.google.com with SMTP id a197so234539150wmd.0 for ; Tue, 08 Nov 2016 02:02:58 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id; bh=2dD1m7jPUOix8RyYwuNTJn1cgLaQasLRE9coS4EN9VM=; b=08SJjbIzj6smKuPD7A46OJCfMBmg4Nhkl/OhOjckjDJm6jBg2voSOb+GL+AtFGgoK4 XiK/W5GjIbJ6q1YaHyJqEOYnowFpz/EO6u/5jG4bugADf3dU4Jz8T24AYyNSouenqIz0 TOCWZPDDp7U2x/U5jdaRWan93S7EdUdhqMrUkrITYNIEIXNtL00XXl2QAs7XPRPiO4qa cviseihKt1ZTq5J9tmH+juK5QrU7QW6MgVal+ae0V86cCXNVWpkWbGYDMT9CHe1PM42o 5T2HSRUwx5UpOHt9PctTFtVmNnYtzCIcorraOnnLWII7AaSQlkv3zyR05b54dX3d6l9H lqPw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=2dD1m7jPUOix8RyYwuNTJn1cgLaQasLRE9coS4EN9VM=; b=EEVhO9Lba7A8JdyJGRE32o/3UZzA2DDLcTCLVLeT9XuKcx62nNAkt+8eUjQ0KgqloU TXxS1cpL7KLfudYPfyu8tlUMMukmomY4MCd1PC/L4UX3FdoervNz3nvoSswReBjdLYMH 5rsVCOYWNsYDzC9dpeJLuIZUHcXHEBbC5fhIPX8ubDn0lUx25KIPLtOxX5DW72XE62KI Y6YCLNzB/RJLYaioiwUqPzSCKACVqQ4SRK42kzJkdpHmjO4AVmIYs0ht4OVDZP2nSwBy UAd3Mnnqiez4KjVeswp8DH8Ac1qSDNBCXiSQp4Tzxlxt9/1WCj+t9ymkZpmB6pqaPf0Z Oxaw== X-Gm-Message-State: ABUngvcXEHqExrOaNHWZEii61uqx3ZFz3GS4Ih70MCkLPLoNf/J73SFiYqS9kcbDQ4l/VQ57 X-Received: by 10.28.63.199 with SMTP id m190mr13219476wma.96.1478599377970; Tue, 08 Nov 2016 02:02:57 -0800 (PST) Received: from XPS13.localdomain (184.203.134.77.rev.sfr.net. [77.134.203.184]) by smtp.gmail.com with ESMTPSA id n6sm36114105wjg.30.2016.11.08.02.02.57 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 08 Nov 2016 02:02:57 -0800 (PST) From: Thomas Monjalon To: John McNamara Cc: dev@dpdk.org, Christian Ehrhardt Date: Tue, 8 Nov 2016 11:02:38 +0100 Message-Id: <1478599358-15921-1-git-send-email-thomas.monjalon@6wind.com> X-Mailer: git-send-email 2.7.0 Subject: [dpdk-dev] [PATCH] doc: move testpmd guide with other tools X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" The guide testpmd_app_ug/ is moved inside the new tools/ guide as a section. Signed-off-by: Thomas Monjalon --- MAINTAINERS | 2 +- doc/guides/conf.py | 2 +- doc/guides/contributing/documentation.rst | 1 - doc/guides/index.rst | 1 - doc/guides/tools/index.rst | 2 +- doc/guides/{testpmd_app_ug => tools/testpmd}/build_app.rst | 0 doc/guides/{testpmd_app_ug => tools/testpmd}/index.rst | 4 ++-- doc/guides/{testpmd_app_ug => tools/testpmd}/intro.rst | 0 doc/guides/{testpmd_app_ug => tools/testpmd}/run_app.rst | 0 doc/guides/{testpmd_app_ug => tools/testpmd}/testpmd_funcs.rst | 0 10 files changed, 5 insertions(+), 7 deletions(-) rename doc/guides/{testpmd_app_ug => tools/testpmd}/build_app.rst (100%) rename doc/guides/{testpmd_app_ug => tools/testpmd}/index.rst (96%) rename doc/guides/{testpmd_app_ug => tools/testpmd}/intro.rst (100%) rename doc/guides/{testpmd_app_ug => tools/testpmd}/run_app.rst (100%) rename doc/guides/{testpmd_app_ug => tools/testpmd}/testpmd_funcs.rst (100%) diff --git a/MAINTAINERS b/MAINTAINERS index ba12d1b..19cd05b 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -614,7 +614,7 @@ F: app/test/virtual_pmd.h Driver testing tool M: Pablo de Lara F: app/test-pmd/ -F: doc/guides/testpmd_app_ug/ +F: doc/guides/tools/testpmd/ Dump tool M: Maryam Tahhan diff --git a/doc/guides/conf.py b/doc/guides/conf.py index 149bcdb..8619d04 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -106,7 +106,7 @@ class CustomLatexFormatter(LatexFormatter): PygmentsBridge.latex_formatter = CustomLatexFormatter # Configuration for man pages -man_pages = [("testpmd_app_ug/run_app", "testpmd", +man_pages = [("tools/testpmd/run_app", "testpmd", "tests for dpdk pmds", "", 1), ("tools/pdump", "dpdk-pdump", "enable packet capture on dpdk ports", "", 1), diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst index 2cfb1a2..03dc59f 100644 --- a/doc/guides/contributing/documentation.rst +++ b/doc/guides/contributing/documentation.rst @@ -31,7 +31,6 @@ The main directories that contain files related to documentation are shown below |-- prog_guide |-- sample_app_ug |-- guidelines - |-- testpmd_app_ug |-- rel_notes |-- nics |-- xen diff --git a/doc/guides/index.rst b/doc/guides/index.rst index 57570f6..25f576a 100644 --- a/doc/guides/index.rst +++ b/doc/guides/index.rst @@ -42,7 +42,6 @@ DPDK documentation cryptodevs/index sample_app_ug/index tools/index - testpmd_app_ug/index faq/index howto/index rel_notes/index diff --git a/doc/guides/tools/index.rst b/doc/guides/tools/index.rst index cbe98b2..f9aa37d 100644 --- a/doc/guides/tools/index.rst +++ b/doc/guides/tools/index.rst @@ -39,4 +39,4 @@ Tool User Guides pdump pmdinfo devbind - + testpmd/index diff --git a/doc/guides/testpmd_app_ug/build_app.rst b/doc/guides/tools/testpmd/build_app.rst similarity index 100% rename from doc/guides/testpmd_app_ug/build_app.rst rename to doc/guides/tools/testpmd/build_app.rst diff --git a/doc/guides/testpmd_app_ug/index.rst b/doc/guides/tools/testpmd/index.rst similarity index 96% rename from doc/guides/testpmd_app_ug/index.rst rename to doc/guides/tools/testpmd/index.rst index 1c39a17..10d2ec0 100644 --- a/doc/guides/testpmd_app_ug/index.rst +++ b/doc/guides/tools/testpmd/index.rst @@ -28,8 +28,8 @@ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -Testpmd Application User Guide -============================== +testpmd Application +=================== .. toctree:: :maxdepth: 3 diff --git a/doc/guides/testpmd_app_ug/intro.rst b/doc/guides/tools/testpmd/intro.rst similarity index 100% rename from doc/guides/testpmd_app_ug/intro.rst rename to doc/guides/tools/testpmd/intro.rst diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/tools/testpmd/run_app.rst similarity index 100% rename from doc/guides/testpmd_app_ug/run_app.rst rename to doc/guides/tools/testpmd/run_app.rst diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/tools/testpmd/testpmd_funcs.rst similarity index 100% rename from doc/guides/testpmd_app_ug/testpmd_funcs.rst rename to doc/guides/tools/testpmd/testpmd_funcs.rst