[1/1] doc: fix build

Message ID 20210126150722.4018058-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [1/1] doc: fix build |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Thomas Monjalon Jan. 26, 2021, 3:07 p.m. UTC
  When removing the label "arm_cross_build_getting_the_prerequisite_library"
in the rework of cross_build_dpdk_for_arm64.rst,
the reference to this section got broken.
It went unnoticed because "ninja -C doc" does not regenerate the file
which is referencing the changed file.

Fixes: eb0e12c0c299 ("doc: add clang to aarch64 cross build guide")

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/platform/bluefield.rst | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)
  

Comments

Bruce Richardson Jan. 26, 2021, 3:32 p.m. UTC | #1
On Tue, Jan 26, 2021 at 04:07:22PM +0100, Thomas Monjalon wrote:
> When removing the label "arm_cross_build_getting_the_prerequisite_library"
> in the rework of cross_build_dpdk_for_arm64.rst,
> the reference to this section got broken.
> It went unnoticed because "ninja -C doc" does not regenerate the file
> which is referencing the changed file.
> 
Do we know why this is? The doc builds should be doing proper dependency
tracking, based off the output from sphinx IIRC.
  
David Marchand Jan. 26, 2021, 3:32 p.m. UTC | #2
On Tue, Jan 26, 2021 at 4:08 PM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> When removing the label "arm_cross_build_getting_the_prerequisite_library"
> in the rework of cross_build_dpdk_for_arm64.rst,
> the reference to this section got broken.
> It went unnoticed because "ninja -C doc" does not regenerate the file
> which is referencing the changed file.
>
> Fixes: eb0e12c0c299 ("doc: add clang to aarch64 cross build guide")
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Reviewed-by: David Marchand <david.marchand@redhat.com>
  
Thomas Monjalon Jan. 26, 2021, 3:35 p.m. UTC | #3
26/01/2021 16:32, Bruce Richardson:
> On Tue, Jan 26, 2021 at 04:07:22PM +0100, Thomas Monjalon wrote:
> > When removing the label "arm_cross_build_getting_the_prerequisite_library"
> > in the rework of cross_build_dpdk_for_arm64.rst,
> > the reference to this section got broken.
> > It went unnoticed because "ninja -C doc" does not regenerate the file
> > which is referencing the changed file.
> > 
> Do we know why this is? The doc builds should be doing proper dependency
> tracking, based off the output from sphinx IIRC.

It seems it is building only the changed files.
I don't understand the logic in buildtools/call-sphinx-build.py
  
Thomas Monjalon Jan. 26, 2021, 3:42 p.m. UTC | #4
26/01/2021 16:32, David Marchand:
> On Tue, Jan 26, 2021 at 4:08 PM Thomas Monjalon <thomas@monjalon.net> wrote:
> >
> > When removing the label "arm_cross_build_getting_the_prerequisite_library"
> > in the rework of cross_build_dpdk_for_arm64.rst,
> > the reference to this section got broken.
> > It went unnoticed because "ninja -C doc" does not regenerate the file
> > which is referencing the changed file.

Adding this explanation:
The fix is a reword not mentioning the "not so relevant" example
from cross_build_dpdk_for_arm64.rst.

> > Fixes: eb0e12c0c299 ("doc: add clang to aarch64 cross build guide")
> >
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Reviewed-by: David Marchand <david.marchand@redhat.com>

Applied
  
Bruce Richardson Jan. 26, 2021, 3:57 p.m. UTC | #5
On Tue, Jan 26, 2021 at 04:35:16PM +0100, Thomas Monjalon wrote:
> 26/01/2021 16:32, Bruce Richardson:
> > On Tue, Jan 26, 2021 at 04:07:22PM +0100, Thomas Monjalon wrote:
> > > When removing the label "arm_cross_build_getting_the_prerequisite_library"
> > > in the rework of cross_build_dpdk_for_arm64.rst,
> > > the reference to this section got broken.
> > > It went unnoticed because "ninja -C doc" does not regenerate the file
> > > which is referencing the changed file.
> > > 
> > Do we know why this is? The doc builds should be doing proper dependency
> > tracking, based off the output from sphinx IIRC.
> 
> It seems it is building only the changed files.
> I don't understand the logic in buildtools/call-sphinx-build.py
> 
That needs some investigation, but it may be sphinx which is at fault
rather than the DPDK build. Most of the extra work done in the wrapper is
processing the files list worked by sphinx so we can mark them as
dependencies of the doc target. Sphinx itself does the incremental builds
of only changed files.

Unfortunately I don't have time to dig into this more right now.
  

Patch

diff --git a/doc/guides/platform/bluefield.rst b/doc/guides/platform/bluefield.rst
index 824f2bde64..635e414600 100644
--- a/doc/guides/platform/bluefield.rst
+++ b/doc/guides/platform/bluefield.rst
@@ -77,12 +77,11 @@  required:
    - libnl-3
    - libnl-route-3
 
-Such header files and libraries can be cross-compiled and installed on to the
-cross toolchain directory like depicted in
-:ref:`arm_cross_build_getting_the_prerequisite_library`, but those can also be
-simply copied from the filesystem of a working BlueField platform. The following
-script can be run on a BlueField platform in order to create a supplementary
-tarball for the cross toolchain.
+Such header files and libraries can be cross-compiled and installed
+in the cross toolchain environment.
+They can also be simply copied from the filesystem of a working BlueField platform.
+The following script can be run on a BlueField platform in order to create
+a supplementary tarball for the cross toolchain.
 
 .. code-block:: console