public inbox for gcc-patches@gcc.gnu.org
 help / color / mirror / Atom feed
From: "Marc Poulhiès" <poulhies@adacore.com>
To: gcc-patches@gcc.gnu.org
Cc: Arnaud Charlet <charlet@adacore.com>
Subject: [Ada] Fix syntax in documentation
Date: Mon, 5 Sep 2022 09:25:50 +0200	[thread overview]
Message-ID: <20220905072550.GA1174480@poulhies-Precision-5550> (raw)

[-- Attachment #1: Type: text/plain, Size: 202 bytes --]

Leading to a poorly formatted example section.

Tested on x86_64-pc-linux-gnu, committed on trunk

gcc/ada/

	* doc/gnat_ugn/gnat_and_program_execution.rst: Fix rest syntax
	* gnat_ugn.texi: Regenerate.

[-- Attachment #2: patch.diff --]
[-- Type: text/x-diff, Size: 2831 bytes --]

diff --git a/gcc/ada/doc/gnat_ugn/gnat_and_program_execution.rst b/gcc/ada/doc/gnat_ugn/gnat_and_program_execution.rst
--- a/gcc/ada/doc/gnat_ugn/gnat_and_program_execution.rst
+++ b/gcc/ada/doc/gnat_ugn/gnat_and_program_execution.rst
@@ -844,9 +844,7 @@ assorted runtime routines and the output will vary from platform to platform.
 
 It is also possible to use ``GDB`` with these traceback addresses to debug
 the program. For example, we can break at a given code location, as reported
-in the stack traceback:
-
-  ::
+in the stack traceback::
 
      $ gdb -nw stb
 
@@ -870,9 +868,8 @@ Executables on recent Windows versions, in other words without using the switch
 with :switch:`--load` instead of the ``addr2line`` tool. The main difference
 is that you need to copy the Load Address output in the traceback ahead of the
 sequence of addresses. And the default mode of ``gnatsymbolize`` is equivalent
-to that of ``addr2line`` with the above switches, so none of them is needed:
+to that of ``addr2line`` with the above switches, so none of them is needed::
 
-  ::
      $ gnatmake stb -g -bargs -E
      $ stb
 


diff --git a/gcc/ada/gnat_ugn.texi b/gcc/ada/gnat_ugn.texi
--- a/gcc/ada/gnat_ugn.texi
+++ b/gcc/ada/gnat_ugn.texi
@@ -19023,15 +19023,12 @@ It is also possible to use @code{GDB} with these traceback addresses to debug
 the program. For example, we can break at a given code location, as reported
 in the stack traceback:
 
-@quotation
-
 @example
 $ gdb -nw stb
 
 (gdb) break *0x401373
 Breakpoint 1 at 0x401373: file stb.adb, line 5.
 @end example
-@end quotation
 
 It is important to note that the stack traceback addresses do not change when
 debug information is included. This is particularly useful because it makes it
@@ -19052,13 +19049,7 @@ is that you need to copy the Load Address output in the traceback ahead of the
 sequence of addresses. And the default mode of @code{gnatsymbolize} is equivalent
 to that of @code{addr2line} with the above switches, so none of them is needed:
 
-@quotation
-
-
-@table @asis
-
-@item ::
-
+@example
 $ gnatmake stb -g -bargs -E
 $ stb
 
@@ -19068,13 +19059,8 @@ Load address: 0x400000
 Call stack traceback locations:
 0x401373 0x40138b 0x40139c 0x401335 0x4011c4 0x4011f1 0x77e892a4
 
-
-@table @asis
-
-@item $ gnatsymbolize –load stb 0x400000 0x401373 0x40138b 0x40139c 0x401335
-
-0x4011c4 0x4011f1 0x77e892a4
-@end table
+$ gnatsymbolize --load stb 0x400000 0x401373 0x40138b 0x40139c 0x401335
+   0x4011c4 0x4011f1 0x77e892a4
 
 0x00401373 Stb.P1 at stb.adb:5
 0x0040138B Stb.P2 at stb.adb:10
@@ -19083,8 +19069,7 @@ Call stack traceback locations:
 0x004011c4 __tmainCRTStartup at ???
 0x004011f1 mainCRTStartup at ???
 0x77e892a4 ??? at ???
-@end table
-@end quotation
+@end example
 
 @subsubheading Tracebacks From Exception Occurrences
 



                 reply	other threads:[~2022-09-05  7:25 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220905072550.GA1174480@poulhies-Precision-5550 \
    --to=poulhies@adacore.com \
    --cc=charlet@adacore.com \
    --cc=gcc-patches@gcc.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).