Commit 6056bc73 by Arnaud Charlet Committed by Pierre-Marie de Rodat

[Ada] Improve gnatmem's doc for the depth switch

2019-07-10  Arnaud Charlet  <charlet@adacore.com>

gcc/ada

	* doc/gnat_ugn/gnat_and_program_execution.rst: Improve gnatmem's
	doc for the depth switch.

From-SVN: r273346
parent 710e0240
2019-07-10 Arnaud Charlet <charlet@adacore.com>
* doc/gnat_ugn/gnat_and_program_execution.rst: Improve gnatmem's
doc for the depth switch.
2019-07-10 Bob Duff <duff@adacore.com> 2019-07-10 Bob Duff <duff@adacore.com>
* doc/gnat_ugn/gnat_utility_programs.rst: Document gnatpp's * doc/gnat_ugn/gnat_utility_programs.rst: Document gnatpp's
......
...@@ -3972,7 +3972,7 @@ execution of this erroneous program: ...@@ -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 The program must have been linked with the instrumented version of the
allocation and deallocation routines. This is done by linking with the allocation and deallocation routines. This is done by linking with the
...@@ -4062,15 +4062,16 @@ execution of this erroneous program: ...@@ -4062,15 +4062,16 @@ execution of this erroneous program:
memory leaks. Omits statistical information. memory leaks. Omits statistical information.
.. index:: N switch (gnatmem) .. index:: DEPTH switch (gnatmem)
:samp:`{N}` :samp:`{DEPTH}`
``N`` is an integer literal (usually between 1 and 10) which controls the ``DEPTH`` is an integer literal (usually between 1 and 10) which controls
depth of the backtraces defining allocation root. The default value for 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 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 the root. Note that the total number of roots can depend on this
parameter. This parameter must be specified *before* the name of the parameter, in other words there may be more roots when the requested
executable to be analyzed, to avoid ambiguity. backtrace depth is higher. This parameter must be specified *before* the
name of the executable to be analyzed, to avoid ambiguity.
.. index:: -b (gnatmem) .. index:: -b (gnatmem)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment