[1/2] maintainer-scripts: fix jit docs on website

Message ID 20241203172054.2262183-1-dmalcolm@redhat.com
State New
Headers
Series [1/2] maintainer-scripts: fix jit docs on website |

Checks

Context Check Description
linaro-tcwg-bot/tcwg_gcc_build--master-aarch64 fail Patch failed to apply
linaro-tcwg-bot/tcwg_gcc_build--master-arm fail Patch failed to apply

Commit Message

David Malcolm Dec. 3, 2024, 5:20 p.m. UTC
  I noticed whilst working on the libgdiagnostics docs
that some errors like this were occurring in the jit docs:

/tmp/gcc-doc-update.3782849/gcc/gcc/jit/docs/cp/topics/asm.rst:63: WARNING: Include file '/tmp/gcc-doc-update.3782849/gcc/gcc/testsuite/jit.dg/test-asm.cc' not found or reading it failed

which was occurring for:
* test-asm.c and .cc
* test-switch.c
* test-accessing-union.c

and indeed https://gcc.gnu.org/onlinedocs/jit/topics/asm.html is
currently missing various code examples.

Fixed thusly; tested locally.

OK for trunk?

maintainer-scripts/ChangeLog:
	* update_web_docs_git: Add the jit testsuite to the files to
	be preserved, since this is used by the jit docs.

Signed-off-by: David Malcolm <dmalcolm@redhat.com>
---
 maintainer-scripts/update_web_docs_git | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
  

Comments

Joseph Myers Dec. 3, 2024, 6:42 p.m. UTC | #1
On Tue, 3 Dec 2024, David Malcolm wrote:

> I noticed whilst working on the libgdiagnostics docs
> that some errors like this were occurring in the jit docs:
> 
> /tmp/gcc-doc-update.3782849/gcc/gcc/jit/docs/cp/topics/asm.rst:63: WARNING: Include file '/tmp/gcc-doc-update.3782849/gcc/gcc/testsuite/jit.dg/test-asm.cc' not found or reading it failed
> 
> which was occurring for:
> * test-asm.c and .cc
> * test-switch.c
> * test-accessing-union.c
> 
> and indeed https://gcc.gnu.org/onlinedocs/jit/topics/asm.html is
> currently missing various code examples.
> 
> Fixed thusly; tested locally.
> 
> OK for trunk?
> 
> maintainer-scripts/ChangeLog:
> 	* update_web_docs_git: Add the jit testsuite to the files to
> 	be preserved, since this is used by the jit docs.

OK.
  

Patch

diff --git a/maintainer-scripts/update_web_docs_git b/maintainer-scripts/update_web_docs_git
index 0d7b6c90fe9c..77210f961cf4 100755
--- a/maintainer-scripts/update_web_docs_git
+++ b/maintainer-scripts/update_web_docs_git
@@ -138,7 +138,7 @@  rm -rf gcc/.git
 # Note that we have to preserve gcc/jit/docs since the jit docs are
 # not .texi files (Makefile, .rst and .png), and the jit docs use
 # include directives to pull in content from jit/jit-common.h and
-# jit/notes.txt, so we have to preserve those also.
+# jit/notes.txt, and from the testsuite, so we have to preserve those also.
 find gcc -type f \( -name '*.texi' \
   -o -path gcc/gcc/doc/install.texi2html \
   -o -path gcc/gcc/doc/include/texinfo.tex \
@@ -148,6 +148,7 @@  find gcc -type f \( -name '*.texi' \
   -o -path "gcc/gcc/jit/docs/*" \
   -o -path "gcc/gcc/jit/jit-common.h" \
   -o -path "gcc/gcc/jit/notes.txt" \
+  -o -path "gcc/gcc/testsuite/jit.dg/*" \
   -o -print0 \) | xargs -0 rm -f
 
 # Build a tarball of the sources.