[dpdk-dev] [PATCH] mk: create pdf docs as a separate make target

[dpdk-dev] [PATCH] mk: create pdf docs as a separate make target

[John McNamara]

This patch separates out the PDF generation from 'make doc' to
'make doc-pdf'. The docs can now be built as follows:

    make doc
    make doc-pdf

This is to:
    * Reduce the PDF dependencies for people who only require
      the Html docs.
    * Speed up the doc build.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
 mk/rte.sdkdoc.mk  | 2 +-
 mk/rte.sdkroot.mk | 3 ++-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk
index 5b44083..b0303f2 100644
--- a/mk/rte.sdkdoc.mk
+++ b/mk/rte.sdkdoc.mk
@@ -60,7 +60,7 @@ help:
 	@$(MAKE) -rR showconfigs | sed 's,^,\t\t\t\t,'
 
 .PHONY: all
-all: api-html guides-html guides-pdf
+all: api-html guides-html
 
 .PHONY: clean
 clean: api-html-clean guides-html-clean guides-pdf-clean
diff --git a/mk/rte.sdkroot.mk b/mk/rte.sdkroot.mk
index e8423b0..eace554 100644
--- a/mk/rte.sdkroot.mk
+++ b/mk/rte.sdkroot.mk
@@ -101,9 +101,10 @@ testall:
 install uninstall:
 	$(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkinstall.mk $@
 
-.PHONY: doc help
+.PHONY: doc help doc-pdf
 doc: doc-all
 help: doc-help
+doc-pdf: doc-guides-pdf
 doc-%:
 	$(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkdoc.mk $*
 
-- 
1.8.1.4

Re: [dpdk-dev] [PATCH] mk: create pdf docs as a separate make target

[Mcnamara, John]

> -----Original Message-----
> From: Mcnamara, John
> Sent: Friday, March 27, 2015 2:35 PM
> To: dev@dpdk.org
> Cc: thomas.monjalon@6wind.com; Mcnamara, John
> Subject: [PATCH] mk: create pdf docs as a separate make target

Hi Thomas,

I acked the patch that introduced this change but we've had a number of complaints from devs who don't want to or can't correctly install the (largish) toolchain for PDF generation, or if they do, don't like the extra time it takes.

John

Re: [dpdk-dev] [PATCH] mk: create pdf docs as a separate make target

[Thomas Monjalon]

2015-03-27 14:40, Mcnamara, John:
> I acked the patch that introduced this change but we've had a number of
> complaints from devs who don't want to or can't correctly install the
> (largish) toolchain for PDF generation, or if they do, don't like the
> extra time it takes.

You forgot to quote my previous explanation.
I don't understand the complaints as they can build only HTML if they want.

Re: [dpdk-dev] [PATCH] mk: create pdf docs as a separate make target

[Thomas Monjalon]

2015-03-27 14:34, John McNamara:
> This patch separates out the PDF generation from 'make doc' to
> 'make doc-pdf'. The docs can now be built as follows:
> 
>     make doc
>     make doc-pdf
> 
> This is to:
>     * Reduce the PDF dependencies for people who only require
>       the Html docs.
>     * Speed up the doc build.
> 
> Signed-off-by: John McNamara <john.mcnamara@intel.com>

NACK

PDF can already be built with "make doc-guides-pdf".
And HTML can be built with "make doc-guides-html doc-api-html".

When using "make doc", we expect building all docs.

Re: [dpdk-dev] [PATCH] mk: create pdf docs as a separate make target

[Mcnamara, John]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Friday, March 27, 2015 3:27 PM
> To: Mcnamara, John
> Cc: dev@dpdk.org
> Subject: Re: [PATCH] mk: create pdf docs as a separate make target
> 
> 
> NACK
> 
> PDF can already be built with "make doc-guides-pdf".
> And HTML can be built with "make doc-guides-html doc-api-html".
> 

Hi,

I know that but clearly not everyone does.

Do we document how to build the docs somewhere. If so I can submit a patch outlining the various doc targets and the PDF prerequisites.

John