[dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3

[dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3

[Tetsuya Mukawa]

Hi John,


It seems after applying following patch, I cannot build doc.
ebf8050 doc: add pdf output

-----------------------
$ T=x86_64-native-linuxapp-gcc make doc

(snip)

lookup cache used 2433/65536 hits=6354 misses=2576
finished...
sphinx processing guides-html...
sphinx processing guides-pdf-freebsd_gsg...

Sphinx error:
Builder name pdf-freebsd_gsg not registered
make[1]: *** [guides-pdf-freebsd_gsg] Error 1
make: *** [doc-all] Error 2
-----------------------

Could you please check it?

Thanks,
Tetsuya

Re: [dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3

[De Lara Guarch, Pablo]

Hi Tetsuya,

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Tetsuya Mukawa
> Sent: Wednesday, April 01, 2015 10:18 AM
> To: Mcnamara, John
> Cc: dev@dpdk.org
> Subject: [dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3
> 
> Hi John,
> 
> 
> It seems after applying following patch, I cannot build doc.
> ebf8050 doc: add pdf output
> 
> -----------------------
> $ T=x86_64-native-linuxapp-gcc make doc
> 
> (snip)
> 
> lookup cache used 2433/65536 hits=6354 misses=2576
> finished...
> sphinx processing guides-html...
> sphinx processing guides-pdf-freebsd_gsg...
> 
> Sphinx error:
> Builder name pdf-freebsd_gsg not registered
> make[1]: *** [guides-pdf-freebsd_gsg] Error 1
> make: *** [doc-all] Error 2
> -----------------------
> 
> Could you please check it?

I have no issues building the docs. Do you have all necessary packages for building them?

You will need texlive, texlive-latex, texlive-collection-latex, texlive-collection-latexrecommended, 
texlive-collection-latexextra and texlive-dejavu.

Pablo
> 
> Thanks,
> Tetsuya

Re: [dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3

[Tetsuya Mukawa]

On 2015/04/01 18:29, De Lara Guarch, Pablo wrote:
> Hi Tetsuya,
>
>> -----Original Message-----
>> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Tetsuya Mukawa
>> Sent: Wednesday, April 01, 2015 10:18 AM
>> To: Mcnamara, John
>> Cc: dev@dpdk.org
>> Subject: [dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3
>>
>> Hi John,
>>
>>
>> It seems after applying following patch, I cannot build doc.
>> ebf8050 doc: add pdf output
>>
>> -----------------------
>> $ T=x86_64-native-linuxapp-gcc make doc
>>
>> (snip)
>>
>> lookup cache used 2433/65536 hits=6354 misses=2576
>> finished...
>> sphinx processing guides-html...
>> sphinx processing guides-pdf-freebsd_gsg...
>>
>> Sphinx error:
>> Builder name pdf-freebsd_gsg not registered
>> make[1]: *** [guides-pdf-freebsd_gsg] Error 1
>> make: *** [doc-all] Error 2
>> -----------------------
>>
>> Could you please check it?
> I have no issues building the docs. Do you have all necessary packages for building them?
>
> You will need texlive, texlive-latex, texlive-collection-latex, texlive-collection-latexrecommended, 
> texlive-collection-latexextra and texlive-dejavu.

Hi Pablo,

Thanks for your reply.
I am using Ubuntu14, so package name may be different.

To make sure, I just installed ’texlive-*’, then tried to build doc again.
But I faced the same error.
Anyway, it seems the error comes from my environment, so I will check it
more.

Thanks,
Tetsuya


> Pablo
>> Thanks,
>> Tetsuya

Re: [dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3

[Mcnamara, John]

> -----Original Message-----
> From: Tetsuya Mukawa [mailto:mukawa@igel.co.jp]
> Sent: Wednesday, April 1, 2015 10:49 AM
> To: De Lara Guarch, Pablo; Mcnamara, John
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3
> 
> I am using Ubuntu14, so package name may be different.
> 
> To make sure, I just installed 'texlive-*', then tried to build doc again.
> But I faced the same error.
> Anyway, it seems the error comes from my environment, so I will check it
> more.

Hi,

Actually that looks like a Makefile issue rather than a toolchain issue. Sphinx shouldn't be trying to build with a builder called "pdf-freebsd_gsg". It seems that it has picked up the wrong rule.

I'll look into it.

John

Re: [dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3

[Masaru Oki]

Hi,

guide-% rule is selected instead of guide-pdf-% in mk/rte.sdkdoc.mk, I guess.


2015-04-01 19:08 GMT+09:00 Mcnamara, John <john.mcnamara@intel.com>:
>> -----Original Message-----
>> From: Tetsuya Mukawa [mailto:mukawa@igel.co.jp]
>> Sent: Wednesday, April 1, 2015 10:49 AM
>> To: De Lara Guarch, Pablo; Mcnamara, John
>> Cc: dev@dpdk.org
>> Subject: Re: [dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3
>>
>> I am using Ubuntu14, so package name may be different.
>>
>> To make sure, I just installed 'texlive-*', then tried to build doc again.
>> But I faced the same error.
>> Anyway, it seems the error comes from my environment, so I will check it
>> more.
>
> Hi,
>
> Actually that looks like a Makefile issue rather than a toolchain issue. Sphinx shouldn't be trying to build with a builder called "pdf-freebsd_gsg". It seems that it has picked up the wrong rule.
>
> I'll look into it.
>
> John

Re: [dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3

[Mcnamara, John]

> -----Original Message-----
> From: Masaru Oki [mailto:m-oki@stratosphere.co.jp]
> Sent: Wednesday, April 1, 2015 11:14 AM
> To: Mcnamara, John
> Cc: Tetsuya Mukawa; De Lara Guarch, Pablo; dev@dpdk.org
> Subject: Re: [dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3
> 
> Hi,
> 
> guide-% rule is selected instead of guide-pdf-% in mk/rte.sdkdoc.mk, I
> guess.

Hi,

Yes, that is the issue. I see it fail with make 3.81 but not 3.82, which might explain why it works on some systems and not on others.

John

Re: [dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3

[Mcnamara, John]

> -----Original Message-----
> From: Masaru Oki [mailto:m-oki@stratosphere.co.jp]
> Sent: Wednesday, April 1, 2015 11:14 AM
> To: Mcnamara, John
> Cc: Tetsuya Mukawa; De Lara Guarch, Pablo; dev@dpdk.org
> Subject: Re: [dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3
> 
> 
> guide-% rule is selected instead of guide-pdf-% in mk/rte.sdkdoc.mk, I
> guess.

Hi,

Changing the order of the guide-pdf-% and guide-% rules fixes the issue with make 3.81. I'll submit a patch.

John

[dpdk-dev] [PATCH] mk: fix for "make doc-guides-pdf" with make 3.81

[John McNamara]

Re-ordered the guide-pdf-% and guide-% rules to allow
the doc-guides-pdf target to build with make 3.81. It
builds unmodified with all later versions of make.

Reported-by: Tetsuya Mukawa <mukawa@igel.co.jp>
Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
 mk/rte.sdkdoc.mk | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk
index 5b44083..0b69d99 100644
--- a/mk/rte.sdkdoc.mk
+++ b/mk/rte.sdkdoc.mk
@@ -94,11 +94,6 @@ guides-pdf-img-clean:
 	$(Q)rm -f $(RTE_SDK)/doc/guides/*/img/*.pdf
 
 guides-pdf: $(addprefix guides-pdf-, $(notdir $(RTE_GUIDES:/=))) ;
-guides-%:
-	@echo 'sphinx processing $@...'
-	$(Q)$(RTE_SPHINX_BUILD) -b $* $(RTE_SPHINX_VERBOSE) \
-		-c $(RTE_SDK)/doc/guides $(RTE_SDK)/doc/guides \
-		$(RTE_OUTPUT)/doc/$*/guides
 
 guides-pdf-%:
 	@echo 'sphinx processing $@...'
@@ -112,6 +107,12 @@ guides-pdf-%:
 	$(Q)mv $(RTE_OUTPUT)/doc/pdf/guides/$*/doc.pdf \
 		$(RTE_OUTPUT)/doc/pdf/guides/$*.pdf
 
+guides-%:
+	@echo 'sphinx processing $@...'
+	$(Q)$(RTE_SPHINX_BUILD) -b $* $(RTE_SPHINX_VERBOSE) \
+		-c $(RTE_SDK)/doc/guides $(RTE_SDK)/doc/guides \
+		$(RTE_OUTPUT)/doc/$*/guides
+
 # Each PDF depends on generated images *.pdf from *.svg
 $(foreach guide, $(RTE_GUIDES), $(foreach img, $(wildcard $(guide)img/*.svg), \
 	$(eval guides-pdf-$(notdir $(guide:/=)): $(img:svg=pdf))))
-- 
1.8.1.4

Fix for issue:

$ ~/tmp/make-3.81/make doc-guides-pdf
sphinx processing guides-pdf-freebsd_gsg...

Sphinx error:
Builder name pdf-freebsd_gsg not registered
make[1]: *** [guides-pdf-freebsd_gsg] Error 1
make: *** [doc-guides-pdf] Error 2

Re: [dpdk-dev] [PATCH] mk: fix for "make doc-guides-pdf" with make 3.81

[De Lara Guarch, Pablo]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of John McNamara
> Sent: Wednesday, April 01, 2015 12:33 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] mk: fix for "make doc-guides-pdf" with make
> 3.81
> 
> Re-ordered the guide-pdf-% and guide-% rules to allow
> the doc-guides-pdf target to build with make 3.81. It
> builds unmodified with all later versions of make.
> 
> Reported-by: Tetsuya Mukawa <mukawa@igel.co.jp>
> Signed-off-by: John McNamara <john.mcnamara@intel.com>

Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>

[dpdk-dev] [PATCH v2] mk: fix pdf doc rules order

[Thomas Monjalon]

From: John McNamara <john.mcnamara@intel.com>

Re-ordered the guide-pdf-% and guide-% rules to allow
the doc-guides-pdf target to build with make 3.81. It
builds unmodified with all later versions of make.

Reported-by: Tetsuya Mukawa <mukawa@igel.co.jp>
Signed-off-by: John McNamara <john.mcnamara@intel.com>
Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---
v2: reorder also clean rules

 mk/rte.sdkdoc.mk | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk
index 5b44083..f91e079 100644
--- a/mk/rte.sdkdoc.mk
+++ b/mk/rte.sdkdoc.mk
@@ -85,21 +85,15 @@ api-html-clean:
 	$(Q)rm -f $(RTE_OUTPUT)/doc/html/api/*
 	$(Q)rmdir -p --ignore-fail-on-non-empty $(RTE_OUTPUT)/doc/html/api 2>&- || true
 
-guides-%-clean:
-	$(Q)rm -rf $(RTE_OUTPUT)/doc/$*/guides
-	$(Q)rmdir -p --ignore-fail-on-non-empty $(RTE_OUTPUT)/doc/$* 2>&- || true
-
 guides-pdf-clean: guides-pdf-img-clean
 guides-pdf-img-clean:
 	$(Q)rm -f $(RTE_SDK)/doc/guides/*/img/*.pdf
 
-guides-pdf: $(addprefix guides-pdf-, $(notdir $(RTE_GUIDES:/=))) ;
-guides-%:
-	@echo 'sphinx processing $@...'
-	$(Q)$(RTE_SPHINX_BUILD) -b $* $(RTE_SPHINX_VERBOSE) \
-		-c $(RTE_SDK)/doc/guides $(RTE_SDK)/doc/guides \
-		$(RTE_OUTPUT)/doc/$*/guides
+guides-%-clean:
+	$(Q)rm -rf $(RTE_OUTPUT)/doc/$*/guides
+	$(Q)rmdir -p --ignore-fail-on-non-empty $(RTE_OUTPUT)/doc/$* 2>&- || true
 
+guides-pdf: $(addprefix guides-pdf-, $(notdir $(RTE_GUIDES:/=))) ;
 guides-pdf-%:
 	@echo 'sphinx processing $@...'
 	$(Q)$(RTE_SPHINX_BUILD) -b latex $(RTE_SPHINX_VERBOSE) \
@@ -112,6 +106,12 @@ guides-pdf-%:
 	$(Q)mv $(RTE_OUTPUT)/doc/pdf/guides/$*/doc.pdf \
 		$(RTE_OUTPUT)/doc/pdf/guides/$*.pdf
 
+guides-%:
+	@echo 'sphinx processing $@...'
+	$(Q)$(RTE_SPHINX_BUILD) -b $* $(RTE_SPHINX_VERBOSE) \
+		-c $(RTE_SDK)/doc/guides $(RTE_SDK)/doc/guides \
+		$(RTE_OUTPUT)/doc/$*/guides
+
 # Each PDF depends on generated images *.pdf from *.svg
 $(foreach guide, $(RTE_GUIDES), $(foreach img, $(wildcard $(guide)img/*.svg), \
 	$(eval guides-pdf-$(notdir $(guide:/=)): $(img:svg=pdf))))
-- 
2.2.2

Re: [dpdk-dev] [PATCH v2] mk: fix pdf doc rules order

[Mcnamara, John]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Wednesday, April 1, 2015 1:31 PM
> To: dev@dpdk.org
> Cc: mukawa@igel.co.jp; Mcnamara, John; De Lara Guarch, Pablo
> Subject: [PATCH v2] mk: fix pdf doc rules order
> 
> From: John McNamara <john.mcnamara@intel.com>
> 
> Re-ordered the guide-pdf-% and guide-% rules to allow the doc-guides-pdf
> target to build with make 3.81. It builds unmodified with all later
> versions of make.
> 
> Reported-by: Tetsuya Mukawa <mukawa@igel.co.jp>
> Signed-off-by: John McNamara <john.mcnamara@intel.com>
> Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
> ---


> v2: reorder also clean rules

Hi Thomas,

That is fine for consistency but there weren't any issues with "make doc-clean" and "make doc-guides-pdf-clean" in the V1 patch/original.

But I'm fine with it like this as well.

John.

Re: [dpdk-dev] [PATCH v2] mk: fix pdf doc rules order

[Thomas Monjalon]

2015-04-01 13:29, Mcnamara, John:
> > -----Original Message-----
> > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > Sent: Wednesday, April 1, 2015 1:31 PM
> > To: dev@dpdk.org
> > Cc: mukawa@igel.co.jp; Mcnamara, John; De Lara Guarch, Pablo
> > Subject: [PATCH v2] mk: fix pdf doc rules order
> > 
> > From: John McNamara <john.mcnamara@intel.com>
> > 
> > Re-ordered the guide-pdf-% and guide-% rules to allow the doc-guides-pdf
> > target to build with make 3.81. It builds unmodified with all later
> > versions of make.
> > 
> > Reported-by: Tetsuya Mukawa <mukawa@igel.co.jp>
> > Signed-off-by: John McNamara <john.mcnamara@intel.com>
> > Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
> > ---
> > v2: reorder also clean rules
> 
> Hi Thomas,
> 
> That is fine for consistency but there weren't any issues with "make doc-clean" and "make doc-guides-pdf-clean" in the V1 patch/original.
> 
> But I'm fine with it like this as well.
> 
> John.

Fixes: ebf8050afd44 ("doc: add pdf output")

Applied, thanks

Re: [dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3

[Tetsuya Mukawa]

On 2015/04/01 20:13, Mcnamara, John wrote:
>> -----Original Message-----
>> From: Masaru Oki [mailto:m-oki@stratosphere.co.jp]
>> Sent: Wednesday, April 1, 2015 11:14 AM
>> To: Mcnamara, John
>> Cc: Tetsuya Mukawa; De Lara Guarch, Pablo; dev@dpdk.org
>> Subject: Re: [dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3
>>
>>
>> guide-% rule is selected instead of guide-pdf-% in mk/rte.sdkdoc.mk, I
>> guess.
> Hi,
>
> Changing the order of the guide-pdf-% and guide-% rules fixes the issue with make 3.81. I'll submit a patch.
>
> John

Hi John and Oki-san,

Thanks, I made sure I could build doc.

Tetsuya