diff mbox series

doc: fix PDF build

Message ID 20190709131117.9885-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: fix PDF build |

Checks

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

Commit Message

Thomas Monjalon July 9, 2019, 1:11 p.m. UTC 
  The command "make doc-guides-pdf" is failing because
there are more than 1500 lines in the file MAINTAINERS
which is included in the contributing guide.

We are facing the issue mentioned in this comment:
https://github.com/sphinx-doc/sphinx/issues/3099#issuecomment-256440704

Anyway the file MAINTAINERS is mentioned several times in the guide.
So the "literalinclude" is removed from the guide to fix the build
of the PDF.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/contributing/patches.rst | 9 ---------
 1 file changed, 9 deletions(-)

Comments

Ferruh Yigit July 9, 2019, 4:53 p.m. UTC | #1 
On 7/9/2019 2:11 PM, Thomas Monjalon wrote:
> The command "make doc-guides-pdf" is failing because
> there are more than 1500 lines in the file MAINTAINERS
> which is included in the contributing guide.
> 
> We are facing the issue mentioned in this comment:
> https://github.com/sphinx-doc/sphinx/issues/3099#issuecomment-256440704
> 
> Anyway the file MAINTAINERS is mentioned several times in the guide.
> So the "literalinclude" is removed from the guide to fix the build
> of the PDF.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Tested-by: Ferruh Yigit <ferruh.yigit@intel.com>
Thomas Monjalon July 10, 2019, 7:44 a.m. UTC | #2 
09/07/2019 18:53, Ferruh Yigit:
> On 7/9/2019 2:11 PM, Thomas Monjalon wrote:
> > The command "make doc-guides-pdf" is failing because
> > there are more than 1500 lines in the file MAINTAINERS
> > which is included in the contributing guide.
> > 
> > We are facing the issue mentioned in this comment:
> > https://github.com/sphinx-doc/sphinx/issues/3099#issuecomment-256440704
> > 
> > Anyway the file MAINTAINERS is mentioned several times in the guide.
> > So the "literalinclude" is removed from the guide to fix the build
> > of the PDF.
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Tested-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied
diff mbox series

Patch

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 3b2b174ad..f37fb5557 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -648,12 +648,3 @@  patch accepted. The general cycle for patch review and acceptance is:
      than rework of the original.
    * Trivial patches may be merged sooner than described above at the tree committer's
      discretion.
-
-DPDK Maintainers
-----------------
-
-The following are the DPDK maintainers as listed in the ``MAINTAINERS`` file
-in the DPDK root directory.
-
-.. literalinclude:: ../../../MAINTAINERS
-   :lines: 3-