Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/2269/?format=api
{ "id": 2269, "url": "https://patches.dpdk.org/api/patches/2269/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/1421255657-19521-2-git-send-email-john.mcnamara@intel.com/", "project": { "id": 1, "url": "https://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<1421255657-19521-2-git-send-email-john.mcnamara@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1421255657-19521-2-git-send-email-john.mcnamara@intel.com", "date": "2015-01-14T17:14:17", "name": "[dpdk-dev,1/2] doc: Add 'make pdf' target to convert guide docs to pdf.", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "92cfc38274662ff03cbc351b0a6c6f67dfe16a05", "submitter": { "id": 154, "url": "https://patches.dpdk.org/api/people/154/?format=api", "name": "John McNamara", "email": "john.mcnamara@intel.com" }, "delegate": null, "mbox": "https://patches.dpdk.org/project/dpdk/patch/1421255657-19521-2-git-send-email-john.mcnamara@intel.com/mbox/", "series": [], "comments": "https://patches.dpdk.org/api/patches/2269/comments/", "check": "pending", "checks": "https://patches.dpdk.org/api/patches/2269/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [IPv6:::1])\n\tby dpdk.org (Postfix) with ESMTP id E77695A1F;\n\tWed, 14 Jan 2015 18:14:26 +0100 (CET)", "from mga14.intel.com (mga14.intel.com [192.55.52.115])\n\tby dpdk.org (Postfix) with ESMTP id 1E66F5686\n\tfor <dev@dpdk.org>; Wed, 14 Jan 2015 18:14:20 +0100 (CET)", "from orsmga003.jf.intel.com ([10.7.209.27])\n\tby fmsmga103.fm.intel.com with ESMTP; 14 Jan 2015 09:09:04 -0800", "from irvmail001.ir.intel.com ([163.33.26.43])\n\tby orsmga003.jf.intel.com with ESMTP; 14 Jan 2015 09:08:06 -0800", "from sivswdev02.ir.intel.com (sivswdev02.ir.intel.com\n\t[10.237.217.46])\n\tby irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id\n\tt0EHEHJK013191; Wed, 14 Jan 2015 17:14:18 GMT", "from sivswdev02.ir.intel.com (localhost [127.0.0.1])\n\tby sivswdev02.ir.intel.com with ESMTP id t0EHEHls019561;\n\tWed, 14 Jan 2015 17:14:17 GMT", "(from jmcnam2x@localhost)\n\tby sivswdev02.ir.intel.com with id t0EHEHhn019557;\n\tWed, 14 Jan 2015 17:14:17 GMT" ], "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos;i=\"5.07,757,1413270000\"; d=\"scan'208\";a=\"512235203\"", "From": "John McNamara <john.mcnamara@intel.com>", "To": "dev@dpdk.org", "Date": "Wed, 14 Jan 2015 17:14:17 +0000", "Message-Id": "<1421255657-19521-2-git-send-email-john.mcnamara@intel.com>", "X-Mailer": "git-send-email 1.7.4.1", "In-Reply-To": "<1421255657-19521-1-git-send-email-john.mcnamara@intel.com>", "References": "<1421255657-19521-1-git-send-email-john.mcnamara@intel.com>", "MIME-Version": "1.0", "Content-Type": "text/plain; charset=UTF-8", "Content-Transfer-Encoding": "8bit", "Subject": "[dpdk-dev] =?utf-8?q?=5BPATCH_1/2=5D_doc=3A_Add_=27make_pdf=27_ta?=\n\t=?utf-8?q?rget_to_convert_guide_docs_to_pdf=2E?=", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "patches and discussions about DPDK <dev.dpdk.org>", "List-Unsubscribe": "<http://dpdk.org/ml/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://dpdk.org/ml/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<http://dpdk.org/ml/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "This patch adds a high level 'make pdf' target to generate\npdf documents from the sphinx/rst user guides.\n\nSigned-off-by: John McNamara <john.mcnamara@intel.com>\n---\n doc/api/sphinx-latex-update.pl | 71 ++++++++++++++++++++++\n doc/guides/freebsd_gsg/conf.py | 86 +++++++++++++++++++++++++++\n doc/guides/linux_gsg/conf.py | 86 +++++++++++++++++++++++++++\n doc/guides/prog_guide/conf.py | 86 +++++++++++++++++++++++++++\n doc/guides/rel_notes/conf.py | 85 ++++++++++++++++++++++++++\n doc/guides/rel_notes/supported_features.rst | 2 +-\n doc/guides/sample_app_ug/conf.py | 86 +++++++++++++++++++++++++++\n doc/guides/sample_app_ug/test_pipeline.rst | 6 +-\n doc/guides/testpmd_app_ug/conf.py | 85 ++++++++++++++++++++++++++\n mk/rte.sdkdoc.mk | 28 +++++++--\n mk/rte.sdkroot.mk | 3 +-\n 11 files changed, 614 insertions(+), 10 deletions(-)\n create mode 100644 doc/api/sphinx-latex-update.pl\n create mode 100644 doc/guides/freebsd_gsg/conf.py\n create mode 100644 doc/guides/linux_gsg/conf.py\n create mode 100644 doc/guides/prog_guide/conf.py\n create mode 100644 doc/guides/rel_notes/conf.py\n create mode 100644 doc/guides/sample_app_ug/conf.py\n create mode 100644 doc/guides/testpmd_app_ug/conf.py", "diff": "diff --git a/doc/api/sphinx-latex-update.pl b/doc/api/sphinx-latex-update.pl\nnew file mode 100644\nindex 0000000..d41c695\n--- /dev/null\n+++ b/doc/api/sphinx-latex-update.pl\n@@ -0,0 +1,71 @@\n+#!/usr/bin/perl -i\n+\n+# BSD LICENSE\n+# Copyright(c) 2010-2014 Intel Corporation. All rights reserved.\n+# All rights reserved.\n+#\n+# Redistribution and use in source and binary forms, with or without\n+# modification, are permitted provided that the following conditions\n+# are met:\n+#\n+# * Redistributions of source code must retain the above copyright\n+# notice, this list of conditions and the following disclaimer.\n+# * Redistributions in binary form must reproduce the above copyright\n+# notice, this list of conditions and the following disclaimer in\n+# the documentation and/or other materials provided with the\n+# distribution.\n+# * Neither the name of Intel Corporation nor the names of its\n+# contributors may be used to endorse or promote products derived\n+# from this software without specific prior written permission.\n+#\n+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n+# \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\n+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\n+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\n+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\n+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n+\n+\n+# Utility program to post-process the Sphinx LaTex docs prior to\n+# generating the latexpdf output.\n+\n+use strict;\n+use warnings;\n+\n+\n+while (<>) {\n+\n+ # Convert escaped single quotes back to real single quote so that\n+ # the Latex upquote package has an effect.\n+ s/\\\\PYGZsq{}/'/g;\n+\n+ # Remove italic form the Pygments formatting.\n+ s/\\\\let\\\\PYG\\@it=\\\\textit//g;\n+\n+ # Change the comments color in the Pygments formatting.\n+ s/0\\.25,0\\.50,0\\.56/0.40,0.69,0.33/;\n+\n+ # Use PNG instead of SVG (which isn't well supported by LaTeX).\n+ if ( /\\\\includegraphics/ ) {\n+ s/\\.svg/.png/;\n+ }\n+\n+ # Center the images.\n+ if ( /^\\\\includegraphics/ ) {\n+ print \"\\\\begin{center}\\n\";\n+ print;\n+ print \"\\\\end{center}\\n\";\n+\n+ next;\n+ }\n+\n+ print;\n+}\n+\n+\n+__END__\ndiff --git a/doc/guides/freebsd_gsg/conf.py b/doc/guides/freebsd_gsg/conf.py\nnew file mode 100644\nindex 0000000..65a7ede\n--- /dev/null\n+++ b/doc/guides/freebsd_gsg/conf.py\n@@ -0,0 +1,86 @@\n+# BSD LICENSE\n+# Copyright(c) 2010-2014 Intel Corporation. All rights reserved.\n+# All rights reserved.\n+#\n+# Redistribution and use in source and binary forms, with or without\n+# modification, are permitted provided that the following conditions\n+# are met:\n+#\n+# * Redistributions of source code must retain the above copyright\n+# notice, this list of conditions and the following disclaimer.\n+# * Redistributions in binary form must reproduce the above copyright\n+# notice, this list of conditions and the following disclaimer in\n+# the documentation and/or other materials provided with the\n+# distribution.\n+# * Neither the name of Intel Corporation nor the names of its\n+# contributors may be used to endorse or promote products derived\n+# from this software without specific prior written permission.\n+#\n+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n+# \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\n+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\n+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\n+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\n+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n+\n+import sys\n+import os\n+\n+source_suffix = '.rst'\n+master_doc = 'index'\n+\n+project = 'DPDK FreeBSD Getting Started Guide'\n+copyright = '2014, Intel'\n+\n+version = '2.0.0'\n+release = version\n+pygments_style = 'sphinx'\n+\n+html_theme = 'default'\n+html_title = 'DPDK FreeBSD Getting Started Guide Documentation'\n+html_show_sphinx = True\n+html_show_copyright = True\n+htmlhelp_basename = 'DPDKFreeBSDGettingStartedGuide'\n+html_add_permalinks = ''\n+\n+latex_preamble = \"\"\"\n+\\\\usepackage{upquote}\n+\\usepackage[utf8]{inputenc}\n+\\\\usepackage{DejaVuSansMono}\n+\\\\usepackage[T1]{fontenc}\n+\\\\usepackage{helvet}\n+\\\\renewcommand{\\\\familydefault}{\\\\sfdefault}\n+\n+\\\\RecustomVerbatimEnvironment{Verbatim}{Verbatim}{xleftmargin=5mm}\n+\"\"\"\n+\n+latex_elements = {\n+ 'papersize': 'a4paper',\n+ 'pointsize': '11pt',\n+ 'preamble': latex_preamble,\n+}\n+\n+latex_documents = [\n+ ('index',\n+ 'dpdk_freebsd_getting_started_guide.tex',\n+ 'The DPDK FreeBSD Getting Started Guide',\n+ 'Intel',\n+ 'manual')\n+]\n+\n+latex_logo = 'img/Intel-logo.png'\n+\n+texinfo_documents = [\n+ ('index',\n+ 'DPDK FreeBSD Getting Started Guide',\n+ 'DPDK FreeBSD Getting Started Guide Documentation',\n+ 'Intel',\n+ 'DPDK FreeBSD Getting Started Guide',\n+ 'One line description of project.',\n+ 'Miscellaneous'),\n+]\ndiff --git a/doc/guides/linux_gsg/conf.py b/doc/guides/linux_gsg/conf.py\nnew file mode 100644\nindex 0000000..355b8bb\n--- /dev/null\n+++ b/doc/guides/linux_gsg/conf.py\n@@ -0,0 +1,86 @@\n+# BSD LICENSE\n+# Copyright(c) 2010-2014 Intel Corporation. All rights reserved.\n+# All rights reserved.\n+#\n+# Redistribution and use in source and binary forms, with or without\n+# modification, are permitted provided that the following conditions\n+# are met:\n+#\n+# * Redistributions of source code must retain the above copyright\n+# notice, this list of conditions and the following disclaimer.\n+# * Redistributions in binary form must reproduce the above copyright\n+# notice, this list of conditions and the following disclaimer in\n+# the documentation and/or other materials provided with the\n+# distribution.\n+# * Neither the name of Intel Corporation nor the names of its\n+# contributors may be used to endorse or promote products derived\n+# from this software without specific prior written permission.\n+#\n+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n+# \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\n+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\n+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\n+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\n+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n+\n+import sys\n+import os\n+\n+source_suffix = '.rst'\n+master_doc = 'index'\n+\n+project = 'DPDK Linux Getting Started Guide'\n+copyright = '2014, Intel'\n+\n+version = '2.0.0'\n+release = version\n+pygments_style = 'sphinx'\n+\n+html_theme = 'default'\n+html_title = 'DPDK Linux Getting Started Guide Documentation'\n+html_show_sphinx = True\n+html_show_copyright = True\n+htmlhelp_basename = 'DPDKLinuxGettingStartedGuide'\n+html_add_permalinks = ''\n+\n+latex_preamble = \"\"\"\n+\\\\usepackage{upquote}\n+\\usepackage[utf8]{inputenc}\n+\\\\usepackage{DejaVuSansMono}\n+\\\\usepackage[T1]{fontenc}\n+\\\\usepackage{helvet}\n+\\\\renewcommand{\\\\familydefault}{\\\\sfdefault}\n+\n+\\\\RecustomVerbatimEnvironment{Verbatim}{Verbatim}{xleftmargin=5mm}\n+\"\"\"\n+\n+latex_elements = {\n+ 'papersize': 'a4paper',\n+ 'pointsize': '11pt',\n+ 'preamble': latex_preamble,\n+}\n+\n+latex_documents = [\n+ ('index',\n+ 'dpdk_linux_getting_started_guide.tex',\n+ 'The DPDK Linux Getting Started Guide',\n+ 'Intel',\n+ 'manual')\n+]\n+\n+latex_logo = 'img/Intel-logo.png'\n+\n+texinfo_documents = [\n+ ('index',\n+ 'DPDK Linux Getting Started Guide',\n+ 'DPDK Linux Getting Started Guide Documentation',\n+ 'Intel',\n+ 'DPDK Linux Getting Started Guide',\n+ 'One line description of project.',\n+ 'Miscellaneous'),\n+]\ndiff --git a/doc/guides/prog_guide/conf.py b/doc/guides/prog_guide/conf.py\nnew file mode 100644\nindex 0000000..d884dac\n--- /dev/null\n+++ b/doc/guides/prog_guide/conf.py\n@@ -0,0 +1,86 @@\n+# BSD LICENSE\n+# Copyright(c) 2010-2014 Intel Corporation. All rights reserved.\n+# All rights reserved.\n+#\n+# Redistribution and use in source and binary forms, with or without\n+# modification, are permitted provided that the following conditions\n+# are met:\n+#\n+# * Redistributions of source code must retain the above copyright\n+# notice, this list of conditions and the following disclaimer.\n+# * Redistributions in binary form must reproduce the above copyright\n+# notice, this list of conditions and the following disclaimer in\n+# the documentation and/or other materials provided with the\n+# distribution.\n+# * Neither the name of Intel Corporation nor the names of its\n+# contributors may be used to endorse or promote products derived\n+# from this software without specific prior written permission.\n+#\n+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n+# \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\n+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\n+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\n+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\n+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n+\n+import sys\n+import os\n+\n+source_suffix = '.rst'\n+master_doc = 'index'\n+\n+project = 'DPDK Programmers Guide'\n+copyright = '2014, Intel'\n+\n+version = '2.0.0'\n+release = version\n+pygments_style = 'sphinx'\n+\n+html_theme = 'default'\n+html_title = 'DPDK Programmers Guide Documentation'\n+html_show_sphinx = True\n+html_show_copyright = True\n+htmlhelp_basename = 'DPDKProgrammersGuide'\n+html_add_permalinks = ''\n+\n+latex_preamble = \"\"\"\n+\\\\usepackage{upquote}\n+\\usepackage[utf8]{inputenc}\n+\\\\usepackage{DejaVuSansMono}\n+\\\\usepackage[T1]{fontenc}\n+\\\\usepackage{helvet}\n+\\\\renewcommand{\\\\familydefault}{\\\\sfdefault}\n+\n+\\\\RecustomVerbatimEnvironment{Verbatim}{Verbatim}{xleftmargin=5mm}\n+\"\"\"\n+\n+latex_elements = {\n+ 'papersize': 'a4paper',\n+ 'pointsize': '11pt',\n+ 'preamble': latex_preamble,\n+}\n+\n+latex_documents = [\n+ ('index',\n+ 'dpdk_programmers_guide.tex',\n+ \"The DPDK Programmer's Guide\",\n+ 'Intel',\n+ 'manual')\n+]\n+\n+latex_logo = 'img/Intel-logo.png'\n+\n+texinfo_documents = [\n+ ('index',\n+ 'DPDK Programmers Guide',\n+ 'DPDK Programmers Guide Documentation',\n+ 'Intel',\n+ 'DPDK Programmers Guide',\n+ 'One line description of project.',\n+ 'Miscellaneous'),\n+]\ndiff --git a/doc/guides/rel_notes/conf.py b/doc/guides/rel_notes/conf.py\nnew file mode 100644\nindex 0000000..6f4cc70\n--- /dev/null\n+++ b/doc/guides/rel_notes/conf.py\n@@ -0,0 +1,85 @@\n+# BSD LICENSE\n+# Copyright(c) 2010-2014 Intel Corporation. All rights reserved.\n+# All rights reserved.\n+#\n+# Redistribution and use in source and binary forms, with or without\n+# modification, are permitted provided that the following conditions\n+# are met:\n+#\n+# * Redistributions of source code must retain the above copyright\n+# notice, this list of conditions and the following disclaimer.\n+# * Redistributions in binary form must reproduce the above copyright\n+# notice, this list of conditions and the following disclaimer in\n+# the documentation and/or other materials provided with the\n+# distribution.\n+# * Neither the name of Intel Corporation nor the names of its\n+# contributors may be used to endorse or promote products derived\n+# from this software without specific prior written permission.\n+#\n+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n+# \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\n+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\n+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\n+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\n+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n+\n+import sys\n+import os\n+\n+source_suffix = '.rst'\n+master_doc = 'index'\n+\n+project = 'DPDK Release Notes'\n+copyright = '2014, Intel'\n+\n+version = '2.0.0'\n+release = version\n+pygments_style = 'sphinx'\n+\n+html_theme = 'default'\n+html_title = 'DPDK Release Notes'\n+html_show_sphinx = True\n+html_show_copyright = True\n+htmlhelp_basename = 'DPDKReleaseNotes'\n+html_add_permalinks = ''\n+\n+latex_preamble = \"\"\"\n+\\\\usepackage{upquote}\n+\\\\usepackage{DejaVuSansMono}\n+\\\\usepackage[T1]{fontenc}\n+\\\\usepackage{helvet}\n+\\\\renewcommand{\\\\familydefault}{\\\\sfdefault}\n+\n+\\\\RecustomVerbatimEnvironment{Verbatim}{Verbatim}{xleftmargin=5mm}\n+\"\"\"\n+\n+latex_elements = {\n+ 'papersize': 'a4paper',\n+ 'pointsize': '11pt',\n+ 'preamble': latex_preamble,\n+}\n+\n+latex_documents = [\n+ ('index',\n+ 'dpdk_release_notes.tex',\n+ 'The DPDK Rlease Notes',\n+ 'Intel',\n+ 'manual')\n+]\n+\n+latex_logo = 'img/Intel-logo.png'\n+\n+texinfo_documents = [\n+ ('index',\n+ 'DPDK Release Notes',\n+ 'DPDK Release Notes',\n+ 'Intel',\n+ 'DPDK Release Notes',\n+ 'One line description of project.',\n+ 'Miscellaneous'),\n+]\ndiff --git a/doc/guides/rel_notes/supported_features.rst b/doc/guides/rel_notes/supported_features.rst\nindex 7936e93..d87fcaa 100644\n--- a/doc/guides/rel_notes/supported_features.rst\n+++ b/doc/guides/rel_notes/supported_features.rst\n@@ -51,7 +51,7 @@ Supported Features\n \n * Intel® X710 40 Gigabit Ethernet Controller\n \n-* Support NIC filters in addition to flow director for Intel� 1GbE and 10GbE Controllers\n+* Support NIC filters in addition to flow director for Intel® 1GbE and 10GbE Controllers\n \n * Virtualization (KVM)\n \ndiff --git a/doc/guides/sample_app_ug/conf.py b/doc/guides/sample_app_ug/conf.py\nnew file mode 100644\nindex 0000000..e7d7d13\n--- /dev/null\n+++ b/doc/guides/sample_app_ug/conf.py\n@@ -0,0 +1,86 @@\n+# BSD LICENSE\n+# Copyright(c) 2010-2014 Intel Corporation. All rights reserved.\n+# All rights reserved.\n+#\n+# Redistribution and use in source and binary forms, with or without\n+# modification, are permitted provided that the following conditions\n+# are met:\n+#\n+# * Redistributions of source code must retain the above copyright\n+# notice, this list of conditions and the following disclaimer.\n+# * Redistributions in binary form must reproduce the above copyright\n+# notice, this list of conditions and the following disclaimer in\n+# the documentation and/or other materials provided with the\n+# distribution.\n+# * Neither the name of Intel Corporation nor the names of its\n+# contributors may be used to endorse or promote products derived\n+# from this software without specific prior written permission.\n+#\n+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n+# \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\n+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\n+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\n+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\n+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n+\n+import sys\n+import os\n+\n+source_suffix = '.rst'\n+master_doc = 'index'\n+\n+project = 'DPDK Sample Applications Guide'\n+copyright = '2014, Intel'\n+\n+version = '2.0.0'\n+release = version\n+pygments_style = 'sphinx'\n+\n+html_theme = 'default'\n+html_title = 'DPDK Sample Applications Guide Documentation'\n+html_show_sphinx = True\n+html_show_copyright = True\n+htmlhelp_basename = 'DPDKSample ApplicationsGuide'\n+html_add_permalinks = ''\n+\n+latex_preamble = \"\"\"\n+\\\\usepackage{upquote}\n+\\usepackage[utf8]{inputenc}\n+\\\\usepackage{DejaVuSansMono}\n+\\\\usepackage[T1]{fontenc}\n+\\\\usepackage{helvet}\n+\\\\renewcommand{\\\\familydefault}{\\\\sfdefault}\n+\n+\\\\RecustomVerbatimEnvironment{Verbatim}{Verbatim}{xleftmargin=5mm}\n+\"\"\"\n+\n+latex_elements = {\n+ 'papersize': 'a4paper',\n+ 'pointsize': '11pt',\n+ 'preamble': latex_preamble,\n+}\n+\n+latex_documents = [\n+ ('index',\n+ 'dpdk_sample_applications_guide.tex',\n+ 'The DPDK Sample Applications Guide',\n+ 'Intel',\n+ 'manual')\n+]\n+\n+latex_logo = 'img/Intel-logo.png'\n+\n+texinfo_documents = [\n+ ('index',\n+ 'DPDK Sample Applications Guide',\n+ 'DPDK Sample Applications Guide Documentation',\n+ 'Intel',\n+ 'DPDK Sample Applications Guide',\n+ 'One line description of project.',\n+ 'Miscellaneous'),\n+]\ndiff --git a/doc/guides/sample_app_ug/test_pipeline.rst b/doc/guides/sample_app_ug/test_pipeline.rst\nindex 867a7a7..07eb3bf 100644\n--- a/doc/guides/sample_app_ug/test_pipeline.rst\n+++ b/doc/guides/sample_app_ug/test_pipeline.rst\n@@ -137,7 +137,7 @@ For hash tables, the following parameters can be selected:\n | | | entries. | hash table with the following key format: |\n | | | | |\n | | | | [4-byte index, 4 bytes of 0] |\n-+-------+------------------------+----------------------------------------------------------+ |\n++-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+\n | 4 | hash-[spec]-8-ext | Extendible bucket hash table with 8-byte key size | The action configured for all table entries is |\n | | | and 16 million entries. | \"Sendto output port\", with the output port index |\n | | | | uniformly distributed for the range of output ports. |\n@@ -156,7 +156,7 @@ For hash tables, the following parameters can be selected:\n | | | entries. | table with the following key format: |\n | | | | |\n | | | | [4-byte index, 12 bytes of 0] |\n-+-------+------------------------+----------------------------------------------------------+ |\n++-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+\n | 6 | hash-[spec]-ash-16-ext | Extendible bucket hash table with 16-byte key size | The action configured for all table entries is |\n | | | and 16 million entries. | \"Send to output port\", with the output port index |\n | | | | uniformly distributed for the range of output ports. |\n@@ -175,7 +175,7 @@ For hash tables, the following parameters can be selected:\n | | | entries. | table with the following key format: |\n | | | | |\n | | | | [4-byte index, 28 bytes of 0]. |\n-+-------+------------------------+----------------------------------------------------------+ |\n++-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+\n | 8 | hash-[spec]-32-ext | Extendible bucket hash table with 32-byte key size | The action configured for all table entries is |\n | | | and 16 million entries. | \"Send to output port\", with the output port index |\n | | | | uniformly distributed for the range of output ports. |\ndiff --git a/doc/guides/testpmd_app_ug/conf.py b/doc/guides/testpmd_app_ug/conf.py\nnew file mode 100644\nindex 0000000..194571c\n--- /dev/null\n+++ b/doc/guides/testpmd_app_ug/conf.py\n@@ -0,0 +1,85 @@\n+# BSD LICENSE\n+# Copyright(c) 2010-2014 Intel Corporation. All rights reserved.\n+# All rights reserved.\n+#\n+# Redistribution and use in source and binary forms, with or without\n+# modification, are permitted provided that the following conditions\n+# are met:\n+#\n+# * Redistributions of source code must retain the above copyright\n+# notice, this list of conditions and the following disclaimer.\n+# * Redistributions in binary form must reproduce the above copyright\n+# notice, this list of conditions and the following disclaimer in\n+# the documentation and/or other materials provided with the\n+# distribution.\n+# * Neither the name of Intel Corporation nor the names of its\n+# contributors may be used to endorse or promote products derived\n+# from this software without specific prior written permission.\n+#\n+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n+# \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\n+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\n+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\n+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\n+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n+\n+import sys\n+import os\n+\n+source_suffix = '.rst'\n+master_doc = 'index'\n+\n+project = 'DPDK Testpmd Application'\n+copyright = '2014, Intel'\n+\n+version = '2.0.0'\n+release = version\n+pygments_style = 'sphinx'\n+\n+html_theme = 'default'\n+html_title = 'DPDK Testpmd Application Documentation'\n+html_show_sphinx = True\n+html_show_copyright = True\n+htmlhelp_basename = 'DPDKTestpmdApplication'\n+html_add_permalinks = ''\n+\n+latex_preamble = \"\"\"\n+\\\\usepackage{upquote}\n+\\\\usepackage{DejaVuSansMono}\n+\\\\usepackage[T1]{fontenc}\n+\\\\usepackage{helvet}\n+\\\\renewcommand{\\\\familydefault}{\\\\sfdefault}\n+\n+\\\\RecustomVerbatimEnvironment{Verbatim}{Verbatim}{xleftmargin=5mm}\n+\"\"\"\n+\n+latex_elements = {\n+ 'papersize': 'a4paper',\n+ 'pointsize': '11pt',\n+ 'preamble': latex_preamble,\n+}\n+\n+latex_documents = [\n+ ('index',\n+ 'dpdk_testpmd_guide.tex',\n+ 'The DPDK Testpmd Application Guide',\n+ 'Intel',\n+ 'manual'),\n+]\n+\n+latex_logo = 'img/Intel-logo.png'\n+\n+texinfo_documents = [\n+ ('index',\n+ 'DPDK Testpmd Application',\n+ 'DPDK Testpmd Application Documentation',\n+ 'Intel',\n+ 'DPDK Testpmd Application',\n+ 'One line description of project.',\n+ 'Miscellaneous'),\n+]\ndiff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk\nindex dabc0d6..1c4dc67 100644\n--- a/mk/rte.sdkdoc.mk\n+++ b/mk/rte.sdkdoc.mk\n@@ -38,10 +38,12 @@ endif\n \n RTE_SPHINX_BUILD = sphinx-build\n ifndef V\n-RTE_SPHINX_VERBOSE := -q\n+RTE_SPHINX_VERBOSE := -q\n+RTE_PDFLATEX_VERBOSE := > /dev/null 2>&1\n endif\n ifeq '$V' '0'\n-RTE_SPHINX_VERBOSE := -q\n+RTE_SPHINX_VERBOSE := -q\n+RTE_PDFLATEX_VERBOSE := > /dev/null 2>&1\n endif\n \n .PHONY: help\n@@ -49,11 +51,11 @@ help:\n \t@cat $(RTE_SDK)/doc/build-sdk-quick.txt\n \t@$(MAKE) -rR showconfigs | sed 's,^,\\t\\t\\t\\t,'\n \n-.PHONY: all\n+.PHONY: all pdf\n all: api-html guides-html\n \n .PHONY: clean\n-clean: api-html-clean guides-html-clean\n+clean: api-html-clean guides-html-clean guides-latex-clean\n \n .PHONY: api-html\n api-html: api-html-clean\n@@ -82,4 +84,20 @@ guides-%-clean:\n guides-%:\n \t@echo 'sphinx for guides...'\n \t$(Q)$(RTE_SPHINX_BUILD) -b $* $(RTE_SPHINX_VERBOSE) \\\n-\t\t-c $(RTE_SDK)/doc/guides $(RTE_SDK)/doc/guides $(RTE_OUTPUT)/doc/$*/guides\n+\t -c $(RTE_SDK)/doc/guides $(RTE_SDK)/doc/guides \\\n+\t $(RTE_OUTPUT)/doc/$*/guides\n+\n+pdf: pdf-rel_notes pdf-linux_gsg pdf-freebsd_gsg pdf-prog_guide \\\n+ pdf-sample_app_ug pdf-testpmd_app_ug\n+\n+pdf-%:\n+\t@echo 'creating' $* 'pdf ...'\n+\t$(Q)$(RTE_SPHINX_BUILD) -b latex $(RTE_SPHINX_VERBOSE) \\\n+\t -c $(RTE_SDK)/doc/guides/$* $(RTE_SDK)/doc/guides/$* \\\n+\t $(RTE_OUTPUT)/doc/latex/guides/$*\n+\t$(Q)cp $(RTE_SDK)/doc/guides/$*/img/*.png \\\n+\t $(RTE_OUTPUT)/doc/latex/guides/$*\n+\t$(Q)perl $(RTE_SDK)/doc/api/sphinx-latex-update.pl \\\n+\t $(RTE_OUTPUT)/doc/latex/guides/$*/*.tex\n+\t$(Q)$(MAKE) -C $(RTE_OUTPUT)/doc/latex/guides/$* \\\n+\t all-pdf $(RTE_PDFLATEX_VERBOSE)\ndiff --git a/mk/rte.sdkroot.mk b/mk/rte.sdkroot.mk\nindex e8423b0..68931bb 100644\n--- a/mk/rte.sdkroot.mk\n+++ b/mk/rte.sdkroot.mk\n@@ -101,9 +101,10 @@ testall:\n install uninstall:\n \t$(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkinstall.mk $@\n \n-.PHONY: doc help\n+.PHONY: doc help pdf\n doc: doc-all\n help: doc-help\n+pdf: doc-pdf\n doc-%:\n \t$(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkdoc.mk $*\n \n", "prefixes": [ "dpdk-dev", "1/2" ] }