* [PATCH] [gdb/doc] Escape the '@' symbols in generated texinfo files.
@ 2023-11-29 15:14 Ciaran Woodward
2023-11-29 20:12 ` Tom Tromey
0 siblings, 1 reply; 4+ messages in thread
From: Ciaran Woodward @ 2023-11-29 15:14 UTC (permalink / raw)
To: gdb-patches; +Cc: Ciaran Woodward
'@' is a special symbol meaning 'command' in GNU texinfo.
If the GDBINIT or GDBINIT_DIR path during configuration
included an '@' character, the makeinfo command would fail,
as it interpreted the '@' in the path as a start of a command
when expanding the path in the docs.
This patch simply escapes any '@' characters in the path,
by replacing them with '@@'. This was already done for the
bugurl variable.
This was detected because the 'Jenkins' tool sometimes puts
an '@' in the workspace path.
---
Note that the generated information is still a little deficient
if you're building a 'relocatable' installation (since the paths
are absolute) but that is not a regression on before.
gdb/doc/Makefile.in | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/gdb/doc/Makefile.in b/gdb/doc/Makefile.in
index 110b6088905..70ee9a8b9cb 100644
--- a/gdb/doc/Makefile.in
+++ b/gdb/doc/Makefile.in
@@ -429,10 +429,12 @@ GDBvn.texi : version.subst
echo "@set SYSTEM_READLINE" >> ./GDBvn.new; \
fi
if [ -n "$(SYSTEM_GDBINIT)" ]; then \
- echo "@set SYSTEM_GDBINIT $(SYSTEM_GDBINIT)" >> ./GDBvn.new; \
+ escaped_system_gdbinit=`echo $(SYSTEM_GDBINIT) | sed 's/@/@@/g'`; \
+ echo "@set SYSTEM_GDBINIT $$escaped_system_gdbinit" >> ./GDBvn.new; \
fi
if [ -n "$(SYSTEM_GDBINIT_DIR)" ]; then \
- echo "@set SYSTEM_GDBINIT_DIR $(SYSTEM_GDBINIT_DIR)" >> ./GDBvn.new; \
+ escaped_system_gdbinit_dir=`echo $(SYSTEM_GDBINIT_DIR) | sed 's/@/@@/g'`; \
+ echo "@set SYSTEM_GDBINIT_DIR $$escaped_system_gdbinit_dir" >> ./GDBvn.new; \
fi
mv GDBvn.new GDBvn.texi
--
2.25.1
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] [gdb/doc] Escape the '@' symbols in generated texinfo files.
2023-11-29 15:14 [PATCH] [gdb/doc] Escape the '@' symbols in generated texinfo files Ciaran Woodward
@ 2023-11-29 20:12 ` Tom Tromey
2023-12-01 16:55 ` Ciaran Woodward
0 siblings, 1 reply; 4+ messages in thread
From: Tom Tromey @ 2023-11-29 20:12 UTC (permalink / raw)
To: Ciaran Woodward; +Cc: gdb-patches
>>>>> Ciaran Woodward <ciaranwoodward@xmos.com> writes:
> '@' is a special symbol meaning 'command' in GNU texinfo.
> If the GDBINIT or GDBINIT_DIR path during configuration
> included an '@' character, the makeinfo command would fail,
> as it interpreted the '@' in the path as a start of a command
> when expanding the path in the docs.
> This patch simply escapes any '@' characters in the path,
> by replacing them with '@@'. This was already done for the
> bugurl variable.
Thank you. This patch is ok.
Approved-By: Tom Tromey <tom@tromey.com>
Tom
^ permalink raw reply [flat|nested] 4+ messages in thread
* RE: [PATCH] [gdb/doc] Escape the '@' symbols in generated texinfo files.
2023-11-29 20:12 ` Tom Tromey
@ 2023-12-01 16:55 ` Ciaran Woodward
2023-12-01 17:46 ` Tom Tromey
0 siblings, 1 reply; 4+ messages in thread
From: Ciaran Woodward @ 2023-12-01 16:55 UTC (permalink / raw)
To: Tom Tromey; +Cc: gdb-patches
> Thank you. This patch is ok.
>
> Approved-By: Tom Tromey <tom@tromey.com>
>
> Tom
Thanks for approving - please could you push it for me?
I sent you an email privately about moving ahead with
write-after-approval access (I have completed the
copyright assignment process), but I guess it might
have been eaten by spam filters?
Thanks,
Ciaran
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] [gdb/doc] Escape the '@' symbols in generated texinfo files.
2023-12-01 16:55 ` Ciaran Woodward
@ 2023-12-01 17:46 ` Tom Tromey
0 siblings, 0 replies; 4+ messages in thread
From: Tom Tromey @ 2023-12-01 17:46 UTC (permalink / raw)
To: Ciaran Woodward; +Cc: Tom Tromey, gdb-patches
Ciaran> I sent you an email privately about moving ahead with
Ciaran> write-after-approval access (I have completed the
Ciaran> copyright assignment process), but I guess it might
Ciaran> have been eaten by spam filters?
It's just me being behind on email.
I will send you some info off list.
Tom
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2023-12-01 17:46 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-11-29 15:14 [PATCH] [gdb/doc] Escape the '@' symbols in generated texinfo files Ciaran Woodward
2023-11-29 20:12 ` Tom Tromey
2023-12-01 16:55 ` Ciaran Woodward
2023-12-01 17:46 ` Tom Tromey
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).