From: Arnaud Charlet Date: Wed, 10 Jul 2019 09:02:27 +0000 (+0000) Subject: [Ada] Improve gnatmem's doc for the depth switch X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=6056bc735d81633bdefe3b696c917d3e4ea20049;p=gcc.git [Ada] Improve gnatmem's doc for the depth switch 2019-07-10 Arnaud Charlet gcc/ada * doc/gnat_ugn/gnat_and_program_execution.rst: Improve gnatmem's doc for the depth switch. From-SVN: r273346 --- diff --git a/gcc/ada/ChangeLog b/gcc/ada/ChangeLog index d7b265c5371..246134c4192 100644 --- a/gcc/ada/ChangeLog +++ b/gcc/ada/ChangeLog @@ -1,3 +1,8 @@ +2019-07-10 Arnaud Charlet + + * doc/gnat_ugn/gnat_and_program_execution.rst: Improve gnatmem's + doc for the depth switch. + 2019-07-10 Bob Duff * doc/gnat_ugn/gnat_utility_programs.rst: Document gnatpp's diff --git a/gcc/ada/doc/gnat_ugn/gnat_and_program_execution.rst b/gcc/ada/doc/gnat_ugn/gnat_and_program_execution.rst index 9cbdb15cf22..de348e9e0b7 100644 --- a/gcc/ada/doc/gnat_ugn/gnat_and_program_execution.rst +++ b/gcc/ada/doc/gnat_ugn/gnat_and_program_execution.rst @@ -3972,7 +3972,7 @@ execution of this erroneous program: :: - $ gnatmem [ switches ] user_program + $ gnatmem [ switches ] [ DEPTH ] user_program The program must have been linked with the instrumented version of the allocation and deallocation routines. This is done by linking with the @@ -4062,15 +4062,16 @@ execution of this erroneous program: memory leaks. Omits statistical information. - .. index:: N switch (gnatmem) + .. index:: DEPTH switch (gnatmem) - :samp:`{N}` - ``N`` is an integer literal (usually between 1 and 10) which controls the - depth of the backtraces defining allocation root. The default value for - N is 1. The deeper the backtrace, the more precise the localization of + :samp:`{DEPTH}` + ``DEPTH`` is an integer literal (usually between 1 and 10) which controls + the depth of the backtraces defining allocation root. The default value for + DEPTH is 1. The deeper the backtrace, the more precise the localization of the root. Note that the total number of roots can depend on this - parameter. This parameter must be specified *before* the name of the - executable to be analyzed, to avoid ambiguity. + parameter, in other words there may be more roots when the requested + backtrace depth is higher. This parameter must be specified *before* the + name of the executable to be analyzed, to avoid ambiguity. .. index:: -b (gnatmem)