Skip to contentSkip to conversation

Cannot build doc using DPDK-2.0.0-rc3

PATCH In review Tetsuya Mukawa 5 participants 13 messages Apr 1, 2015 – Apr 2, 2015 9 messages not in the archive

lore
Share & tools
lore

Tetsuya Mukawa

author
#0 lore raw

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

A message that is not in the archive (sent off-list or not yet received): 551BB7C0.1020004-AlSX/UN32fvPDbFq/[email protected]

#2 lore raw

Hi Tetsuya,

Quoted 23 lines

-----Original Message-----
From: dev [mailto:[email protected]] On Behalf Of Tetsuya Mukawa
Sent: Wednesday, April 01, 2015 10:18 AM
To: Mcnamara, John
Cc: [email protected]
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...

Quoted 7 lines

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

Quoted 3 lines

Thanks,
Tetsuya

A message that is not in the archive (sent off-list or not yet received): E115CCD9D858EF4F90C690B0DCB4D8972728570E-kPTMFJFq+rEMvF1YICWikbfspsVTdybXVpNB7YpNyf8@public.gmane.org

author
#4 lore raw
Quoted 31 lines · Pablo

Hi Tetsuya,

Quoted 29 lines

-----Original Message-----
From: dev [mailto:[email protected]] On Behalf Of Tetsuya Mukawa
Sent: Wednesday, April 01, 2015 10:18 AM
To: Mcnamara, John
Cc: [email protected]
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
-----------------------

Quoted 5 lines
Quoted 1 line

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

Quoted 3 lines

Pablo

Quoted 2 lines

Thanks,
Tetsuya

A message that is not in the archive (sent off-list or not yet received): 551BBF28.4010609-AlSX/UN32fvPDbFq/[email protected]

#6 lore raw
Quoted 7 lines

-----Original Message-----
From: Tetsuya Mukawa [mailto:mukawa-AlSX/UN32fvPDbFq/[email protected]]
Sent: Wednesday, April 1, 2015 10:49 AM
To: De Lara Guarch, Pablo; Mcnamara, John
Cc: [email protected]
Subject: Re: [dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3

Quoted 6 lines

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

A message that is not in the archive (sent off-list or not yet received): B27915DBBA3421428155699D51E4CFE2F00BB1-kPTMFJFq+rELt2AQoY/[email protected]

#8 lore raw

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 <[email protected]>:

Quoted 21 lines
Quoted 7 lines

-----Original Message-----
From: Tetsuya Mukawa [mailto:mukawa-AlSX/UN32fvPDbFq/[email protected]]
Sent: Wednesday, April 1, 2015 10:49 AM
To: De Lara Guarch, Pablo; Mcnamara, John
Cc: [email protected]
Subject: Re: [dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3

Quoted 6 lines

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

A message that is not in the archive (sent off-list or not yet received): CAFLKUzJsf4n-K=2Z2MAkZAS05YN++Afd+GUYKyHJ-5U805=5rw-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org

#10 lore raw
Quoted 11 lines

-----Original Message-----
From: Masaru Oki [mailto:[email protected]]
Sent: Wednesday, April 1, 2015 11:14 AM
To: Mcnamara, John
Cc: Tetsuya Mukawa; De Lara Guarch, Pablo; [email protected]
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

#11 lore raw
In reply to a message not in the archive
Quoted 10 lines

-----Original Message-----
From: Masaru Oki [mailto:[email protected]]
Sent: Wednesday, April 1, 2015 11:14 AM
To: Mcnamara, John
Cc: Tetsuya Mukawa; De Lara Guarch, Pablo; [email protected]
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

A message that is not in the archive (sent off-list or not yet received): B27915DBBA3421428155699D51E4CFE2F00C2E-kPTMFJFq+rELt2AQoY/[email protected]

author
#13 lore raw
Quoted 8 lines · John
Quoted 8 lines

-----Original Message-----
From: Masaru Oki [mailto:m-oki-kJJssGRo5Gr08ZWpFnN8/[email protected]]
Sent: Wednesday, April 1, 2015 11:14 AM
To: Mcnamara, John
Cc: Tetsuya Mukawa; De Lara Guarch, Pablo; [email protected]
Subject: Re: [dpdk-dev] Cannot build doc using DPDK-2.0.0-rc3

Quoted 7 lines
Quoted 2 lines

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

#14 lore raw

PATCH 1/1 mk: fix for "make doc-guides-pdf" with make 3.81

In reply to a message not in the archive

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-AlSX/UN32fvPDbFq/[email protected]>
Signed-off-by John McNamara <[email protected]>
---
 mk/rte.sdkdoc.mk | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)
mk/rte.sdkdoc.mk +6 -5
index 5b44083..0b69d99 100644
@@ -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))))
Signature · 11 lines
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

A message that is not in the archive (sent off-list or not yet received): 1427887965-19651-1-git-send-email-john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org

Acked-by
#16 lore raw

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

Quoted 9 lines

-----Original Message-----
From: dev [mailto:[email protected]] On Behalf Of John McNamara
Sent: Wednesday, April 01, 2015 12:33 PM
To: [email protected]
Subject: [dpdk-dev] [PATCH] mk: fix for "make doc-guides-pdf" with make 3.81

Quoted 6 lines

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-AlSX/UN32fvPDbFq/[email protected]>
Signed-off-by John McNamara <[email protected]>
Acked-by Pablo de Lara <[email protected]>
#17 lore raw

PATCH v2 1/1 mk: fix pdf doc rules order

In reply to a message not in the archive

From: John McNamara <[email protected]>

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-AlSX/UN32fvPDbFq/[email protected]>
Signed-off-by John McNamara <[email protected]>
Signed-off-by Thomas Monjalon <[email protected]>

---
v2: reorder also clean rules

 mk/rte.sdkdoc.mk | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)
mk/rte.sdkdoc.mk +10 -10
index 5b44083..f91e079 100644
@@ -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))))
Signature · 1 line
2.2.2

A message that is not in the archive (sent off-list or not yet received): 1427891478-26398-1-git-send-email-thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org

#19 lore raw

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

Quoted 13 lines

-----Original Message-----
From: Thomas Monjalon [mailto:[email protected]]
Sent: Wednesday, April 1, 2015 1:31 PM
To: [email protected]
Cc: mukawa-AlSX/UN32fvPDbFq/[email protected]; Mcnamara, John; De Lara Guarch, Pablo
Subject: [PATCH v2] mk: fix pdf doc rules order

From: John McNamara <[email protected]>

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.

Quoted 7 lines
Reported-by Tetsuya Mukawa <mukawa-AlSX/UN32fvPDbFq/[email protected]>
Signed-off-by John McNamara <[email protected]>
Signed-off-by Thomas Monjalon <[email protected]>

---

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.

A message that is not in the archive (sent off-list or not yet received): B27915DBBA3421428155699D51E4CFE2F00D9C-kPTMFJFq+rELt2AQoY/[email protected]

Applied
#21 lore raw

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

2015-04-01 13:29, Mcnamara, John:

Quoted 19 lines
Quoted 13 lines

-----Original Message-----
From: Thomas Monjalon [mailto:[email protected]]
Sent: Wednesday, April 1, 2015 1:31 PM
To: [email protected]
Cc: mukawa-AlSX/UN32fvPDbFq/[email protected]; Mcnamara, John; De Lara Guarch, Pablo
Subject: [PATCH v2] mk: fix pdf doc rules order

From: John McNamara <[email protected]>

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.

Quoted 5 lines
Reported-by Tetsuya Mukawa <mukawa-AlSX/UN32fvPDbFq/[email protected]>
Signed-off-by John McNamara <[email protected]>
Signed-off-by Thomas Monjalon <[email protected]>

---
v2: reorder also clean rules

Quoted 7 lines

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