[v2,18.11,17.11] doc: in doc-clean removed the folder not containing rst files
diff mbox series

Message ID 20200320080201.14171-1-m.bilal@emumba.com
State Not Applicable, archived
Headers show
Series
  • [v2,18.11,17.11] doc: in doc-clean removed the folder not containing rst files
Related show

Checks

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

Commit Message

Muhammad Bilal March 20, 2020, 8:02 a.m. UTC
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
Cc: Thomas Monjalon <thomas@monjalon.net>
Cc: John McNamara <john.mcnamara@intel.com>
Cc: M: Luca Boccassi <bluca@debian.org>
Cc: dev@dpdk.org
Cc: stable@dpdk.org
Signed-off-by: Muhammad Bilal <m.bilal@emumba.com>
---
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(-)

Comments

Luca Boccassi March 20, 2020, 9:39 a.m. UTC | #1
On Fri, 2020-03-20 at 13:02 +0500, Muhammad Bilal wrote:
> 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
> Cc: Thomas Monjalon <thomas@monjalon.net>
> Cc: John McNamara <john.mcnamara@intel.com>
> Cc: M: Luca Boccassi <bluca@debian.org>
> Cc: dev@dpdk.org
> Cc: stable@dpdk.org
> Signed-off-by: Muhammad Bilal <m.bilal@emumba.com>
> ---
> 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.
Muhammad Bilal March 20, 2020, 9:53 a.m. UTC | #2
On Fri, Mar 20, 2020 at 2:39 PM Luca Boccassi <bluca@debian.org> wrote:
>
> On Fri, 2020-03-20 at 13:02 +0500, Muhammad Bilal wrote:
> > 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
> > Cc: Thomas Monjalon <thomas@monjalon.net>
> > Cc: John McNamara <john.mcnamara@intel.com>
> > Cc: M: Luca Boccassi <bluca@debian.org>
> > Cc: dev@dpdk.org
> > Cc: stable@dpdk.org
> > Signed-off-by: Muhammad Bilal <m.bilal@emumba.com>
> > ---
> > 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.
>
This bug also occurs on 18.11
So this patch is also valid for 18.11.
> --
> Kind regards,
> Muhammad Bilal
Kevin Traynor March 20, 2020, 10:02 a.m. UTC | #3
On 20/03/2020 09:53, Muhammad Bilal wrote:
> On Fri, Mar 20, 2020 at 2:39 PM Luca Boccassi <bluca@debian.org> wrote:
>>
>> On Fri, 2020-03-20 at 13:02 +0500, Muhammad Bilal wrote:
>>> 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
>>> Cc: Thomas Monjalon <thomas@monjalon.net>
>>> Cc: John McNamara <john.mcnamara@intel.com>
>>> Cc: M: Luca Boccassi <bluca@debian.org>
>>> Cc: dev@dpdk.org
>>> Cc: stable@dpdk.org
>>> Signed-off-by: Muhammad Bilal <m.bilal@emumba.com>
>>> ---
>>> 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.
>>
> 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.

>> --
>> Kind regards,
>> Muhammad Bilal
>
Muhammad Bilal March 24, 2020, 7:04 a.m. UTC | #4
On Fri, Mar 20, 2020 at 3:02 PM Kevin Traynor <ktraynor@redhat.com> wrote:
>
> On 20/03/2020 09:53, Muhammad Bilal wrote:
> > On Fri, Mar 20, 2020 at 2:39 PM Luca Boccassi <bluca@debian.org> wrote:
> >>
> >> On Fri, 2020-03-20 at 13:02 +0500, Muhammad Bilal wrote:
> >>> 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
> >>> Cc: Thomas Monjalon <thomas@monjalon.net>
> >>> Cc: John McNamara <john.mcnamara@intel.com>
> >>> Cc: M: Luca Boccassi <bluca@debian.org>
> >>> Cc: dev@dpdk.org
> >>> Cc: stable@dpdk.org
> >>> Signed-off-by: Muhammad Bilal <m.bilal@emumba.com>
> >>> ---
> >>> 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.
> >>
> > 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.
> >> --
> >> Kind regards,
> >> Muhammad Bilal
> >
>
Kevin Traynor March 24, 2020, 12:57 p.m. UTC | #5
On 24/03/2020 07:04, Muhammad Bilal wrote:
> On Fri, Mar 20, 2020 at 3:02 PM Kevin Traynor <ktraynor@redhat.com> wrote:
>>
>> On 20/03/2020 09:53, Muhammad Bilal wrote:
>>> On Fri, Mar 20, 2020 at 2:39 PM Luca Boccassi <bluca@debian.org> wrote:
>>>>
>>>> On Fri, 2020-03-20 at 13:02 +0500, Muhammad Bilal wrote:
>>>>> 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
>>>>> Cc: Thomas Monjalon <thomas@monjalon.net>
>>>>> Cc: John McNamara <john.mcnamara@intel.com>
>>>>> Cc: M: Luca Boccassi <bluca@debian.org>
>>>>> Cc: dev@dpdk.org
>>>>> Cc: stable@dpdk.org
>>>>> Signed-off-by: Muhammad Bilal <m.bilal@emumba.com>
>>>>> ---
>>>>> 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.
>>>>
>>> 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 <aideen.mcloughlin@intel.com>
Date:   Thu Jun 27 14:58:19 2019 +0100

    doc: add search engine for API

>>>> --
>>>> Kind regards,
>>>> Muhammad Bilal
>>>
>>
>
Kevin Traynor April 15, 2020, 4:51 p.m. UTC | #6
On 24/03/2020 12:57, Kevin Traynor wrote:
> On 24/03/2020 07:04, Muhammad Bilal wrote:
>> On Fri, Mar 20, 2020 at 3:02 PM Kevin Traynor <ktraynor@redhat.com> wrote:
>>>
>>> On 20/03/2020 09:53, Muhammad Bilal wrote:
>>>> On Fri, Mar 20, 2020 at 2:39 PM Luca Boccassi <bluca@debian.org> wrote:
>>>>>
>>>>> On Fri, 2020-03-20 at 13:02 +0500, Muhammad Bilal wrote:
>>>>>> 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
>>>>>> Cc: Thomas Monjalon <thomas@monjalon.net>
>>>>>> Cc: John McNamara <john.mcnamara@intel.com>
>>>>>> Cc: M: Luca Boccassi <bluca@debian.org>
>>>>>> Cc: dev@dpdk.org
>>>>>> Cc: stable@dpdk.org
>>>>>> Signed-off-by: Muhammad Bilal <m.bilal@emumba.com>
>>>>>> ---
>>>>>> 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.
>>>>>
>>>> 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.
> 

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

> [1]
> commit 92d6c874d33dbbd3ace7c06a3490a61ff6641d61
> Author: Aideen McLoughlin <aideen.mcloughlin@intel.com>
> Date:   Thu Jun 27 14:58:19 2019 +0100
> 
>     doc: add search engine for API
> 
>>>>> --
>>>>> Kind regards,
>>>>> Muhammad Bilal
>>>>
>>>
>>
>

Patch
diff mbox series

diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk
index c44db6447..a80250ce8 100644
--- a/mk/rte.sdkdoc.mk
+++ b/mk/rte.sdkdoc.mk
@@ -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