Skip to contentSkip to conversation

doc: in doc-clean removed the folder not containing rst files

PATCH In review Muhammad Bilal 3 participants 7 messages Mar 20, 2020 – Apr 15, 2020 1 message not in the archive

lore
Share & tools
lore

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

#1 lore raw

PATCH v2 1/1 doc: in doc-clean removed the folder not containing rst files

in doc-clean removing the folder which contain the text files and no .rst files,
they cause problem When switching branches and compiling the documentation for older releases (for example building a documentation on 18.11 or 17.11, with a documentation on master branch, built before.

Bugzilla ID: 364

---
v2:
* Added Details of branches for which patch is used.
* This patch is intended for v18.11 and v17.11 branches

 mk/rte.sdkdoc.mk | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
mk/rte.sdkdoc.mk +6 -2
index c44db6447..a80250ce8 100644
@@ -37,7 +37,7 @@ help:
 all: api-html guides-html guides-pdf
 
 .PHONY: clean
-clean: api-html-clean guides-html-clean guides-pdf-clean guides-man-clean
+clean: api-html-clean guides-html-clean guides-pdf-clean guides-man-clean guide-table-clean
 
 .PHONY: api-html
 api-html: $(API_EXAMPLES)
@@ -56,7 +56,7 @@ api-html: $(API_EXAMPLES)
 .PHONY: api-html-clean
 api-html-clean:
 	$(Q)rm -f $(API_EXAMPLES)
-	$(Q)rm -f $(RTE_OUTPUT)/doc/html/api/*
+	$(Q)rm -rf $(RTE_OUTPUT)/doc/html/api/*
 	$(Q)rmdir -p --ignore-fail-on-non-empty $(RTE_OUTPUT)/doc/html/api 2>&- || true
 
 $(API_EXAMPLES): api-html-clean
@@ -67,6 +67,10 @@ guides-pdf-clean: guides-pdf-img-clean
 guides-pdf-img-clean:
 	$(Q)rm -f $(RTE_SDK)/doc/guides/*/img/*.pdf
 
+guide-table-clean: guide-overview_feature_table-clean
+guide-overview_feature_table-clean:
+	$(Q)rm -rf $(shell find $(RTE_SDK)/doc/guides/ -maxdepth 1 -type d '!' -exec test -e "{}/index.rst" ';' -print)
+
 guides-%-clean:
 	$(Q)rm -rf $(RTE_OUTPUT)/doc/$*/guides
 	$(Q)rmdir -p --ignore-fail-on-non-empty $(RTE_OUTPUT)/doc/$* 2>&- || true
Signature · 1 line
2.17.1
#2 lore raw
Quoted 14 lines · Muhammad Bilal

in doc-clean removing the folder which contain the text files and no .rst files,
they cause problem When switching branches and compiling the documentation for older releases (for example building a documentation on 18.11 or 17.11, with a documentation on master branch, built before.

Bugzilla ID: 364

Quoted 4 lines

---
v2:
* Added Details of branches for which patch is used.
* This patch is intended for v18.11 and v17.11 branches

Thanks for the patch, but 17.11 is EOL and will no longer receive updates.

Signature · 2 lines
Kind regards,
Luca Boccassi
#3 lore raw
Quoted 21 lines · Luca Boccassi
Quoted 14 lines · Muhammad Bilal

in doc-clean removing the folder which contain the text files and no .rst files,
they cause problem When switching branches and compiling the documentation for older releases (for example building a documentation on 18.11 or 17.11, with a documentation on master branch, built before.

Bugzilla ID: 364

Quoted 4 lines

---
v2:
* Added Details of branches for which patch is used.
* This patch is intended for v18.11 and v17.11 branches

Quoted 3 lines

Thanks for the patch, but 17.11 is EOL and will no longer receive updates.

This bug also occurs on 18.11
So this patch is also valid for 18.11.

Quoted 3 lines

--
Kind regards,
Muhammad Bilal

#4 lore raw
Quoted 22 lines · Muhammad Bilal
Quoted 21 lines · Luca Boccassi
Quoted 18 lines · Muhammad Bilal

in doc-clean removing the folder which contain the text files and no .rst files,
they cause problem When switching branches and compiling the documentation for older releases (for example building a documentation on 18.11 or 17.11, with a documentation on master branch, built before.

Bugzilla ID: 364

---
v2:
* Added Details of branches for which patch is used.
* This patch is intended for v18.11 and v17.11 branches

Quoted 5 lines
Quoted 3 lines

Thanks for the patch, but 17.11 is EOL and will no longer receive updates.

This bug also occurs on 18.11
So this patch is also valid for 18.11.

Thanks for the fix. This patch is for dpdk master as well, right?

If so, will backport to 18.11 as part of normal rounds of backporting from master to 18.11.

Quoted 4 lines
Quoted 3 lines

--
Kind regards,
Muhammad Bilal

#5 lore raw
Quoted 38 lines · Kevin Traynor
Quoted 22 lines · Muhammad Bilal
Quoted 21 lines · Luca Boccassi
Quoted 18 lines · Muhammad Bilal

in doc-clean removing the folder which contain the text files and no .rst files,
they cause problem When switching branches and compiling the documentation for older releases (for example building a documentation on 18.11 or 17.11, with a documentation on master branch, built before.

Bugzilla ID: 364

---
v2:
* Added Details of branches for which patch is used.
* This patch is intended for v18.11 and v17.11 branches

Quoted 5 lines
Quoted 3 lines

Thanks for the patch, but 17.11 is EOL and will no longer receive updates.

This bug also occurs on 18.11
So this patch is also valid for 18.11.

No, This patch is not for dpdk master, it is intended only for 18.11 branch
when we switch to 18.11 branch (after making documentation in master or newer branch ) an error occurs in making documentation on 18.11 branch. So This patch is intended to solve this problem.

Quoted 4 lines
Quoted 3 lines

--
Kind regards,
Muhammad Bilal

#6 lore raw
Quoted 28 lines · Muhammad Bilal
Quoted 27 lines · Kevin Traynor
Quoted 25 lines · Muhammad Bilal
Quoted 24 lines · Luca Boccassi
Quoted 14 lines · Muhammad Bilal

in doc-clean removing the folder which contain the text files and no .rst files,
they cause problem When switching branches and compiling the documentation for older releases (for example building a documentation on 18.11 or 17.11, with a documentation on master branch, built before.

Bugzilla ID: 364

Quoted 4 lines

---
v2:
* Added Details of branches for which patch is used.
* This patch is intended for v18.11 and v17.11 branches

Thanks for the patch, but 17.11 is EOL and will no longer receive updates.

Quoted 6 lines
Quoted 6 lines
Quoted 2 lines

This bug also occurs on 18.11
So this patch is also valid for 18.11.

No, This patch is not for dpdk master, it is intended only for 18.11 branch
when we switch to 18.11 branch (after making documentation in master or newer branch ) an error occurs in making documentation on 18.11 branch. So This patch is intended to solve this problem.

The line to remove the search dir from commit [1] fixes the api build for me.

My pdf build is not working atm and I'm not sure about the paths. Can doc maintainers review this please.

[1]
commit 92d6c874d33dbbd3ace7c06a3490a61ff6641d61

Author: Aideen McLoughlin <[email protected]>
Date:   Thu Jun 27 14:58:19 2019 +0100

doc: add search engine for API

Quoted 6 lines
Quoted 5 lines
Quoted 4 lines
Quoted 3 lines

--
Kind regards,
Muhammad Bilal

#7 lore raw
Quoted 36 lines · Kevin Traynor
Quoted 28 lines · Muhammad Bilal
Quoted 27 lines · Kevin Traynor
Quoted 25 lines · Muhammad Bilal
Quoted 24 lines · Luca Boccassi
Quoted 14 lines · Muhammad Bilal

in doc-clean removing the folder which contain the text files and no .rst files,
they cause problem When switching branches and compiling the documentation for older releases (for example building a documentation on 18.11 or 17.11, with a documentation on master branch, built before.

Bugzilla ID: 364

Quoted 4 lines

---
v2:
* Added Details of branches for which patch is used.
* This patch is intended for v18.11 and v17.11 branches

Thanks for the patch, but 17.11 is EOL and will no longer receive updates.

Quoted 6 lines
Quoted 6 lines
Quoted 2 lines

This bug also occurs on 18.11
So this patch is also valid for 18.11.

No, This patch is not for dpdk master, it is intended only for 18.11 branch
when we switch to 18.11 branch (after making documentation in master or newer branch ) an error occurs in making documentation on 18.11 branch. So This patch is intended to solve this problem.

Quoted 6 lines

The line to remove the search dir from commit [1] fixes the api build for me.

My pdf build is not working atm and I'm not sure about the paths. Can doc maintainers review this please.

pdf part not fully reviewed. Reworded commit message, removed the additional tags and applied. Thanks.

Quoted 14 lines

[1]
commit 92d6c874d33dbbd3ace7c06a3490a61ff6641d61

Author: Aideen McLoughlin <[email protected]>
Date:   Thu Jun 27 14:58:19 2019 +0100

doc: add search engine for API

Quoted 6 lines
Quoted 5 lines
Quoted 4 lines
Quoted 3 lines

--
Kind regards,
Muhammad Bilal