Commit 86ae194f by Bob Duff Committed by Pierre-Marie de Rodat

[Ada] Clarify documentation for Stack_Usage

Clarify the documentation for Stack_Usage (both comments in the code,
and user documentation) to note that tools like Valgrind won't work.

2019-09-17  Bob Duff  <duff@adacore.com>

gcc/ada/

	* doc/gnat_ugn/gnat_and_program_execution.rst: Clarify
	documentation.
	* gnat_ugn.texi: Regenerate.
	* libgnat/s-stausa.ads: Clarify comments.

From-SVN: r275787
parent 0a39f241
2019-09-17 Bob Duff <duff@adacore.com>
* doc/gnat_ugn/gnat_and_program_execution.rst: Clarify
documentation.
* gnat_ugn.texi: Regenerate.
* libgnat/s-stausa.ads: Clarify comments.
2019-09-17 Steve Baird <baird@adacore.com> 2019-09-17 Steve Baird <baird@adacore.com>
* sem_util.adb (Wrong_Type): In deciding to suppress a message, * sem_util.adb (Wrong_Type): In deciding to suppress a message,
......
...@@ -3396,8 +3396,11 @@ adding a switch to ``gnatbind``, as: ...@@ -3396,8 +3396,11 @@ adding a switch to ``gnatbind``, as:
$ gnatbind -u0 file $ gnatbind -u0 file
With this option, at each task termination, its stack usage is output on With this option, at each task termination, its stack usage is output on
:file:`stderr`. :file:`stderr`.
Note that this switch is not compatible with tools like
Valgrind and DrMemory; they will report errors.
It is not always convenient to output the stack usage when the program It is not always convenient to output the stack usage when the program
is still running. Hence, it is possible to delay this output until program is still running. Hence, it is possible to delay this output until program
termination. for a given number of tasks specified as the argument of the termination. for a given number of tasks specified as the argument of the
......
...@@ -21,7 +21,7 @@ ...@@ -21,7 +21,7 @@
@copying @copying
@quotation @quotation
GNAT User's Guide for Native Platforms , Sep 13, 2019 GNAT User's Guide for Native Platforms , Sep 14, 2019
AdaCore AdaCore
...@@ -23321,8 +23321,11 @@ $ gnatbind -u0 file ...@@ -23321,8 +23321,11 @@ $ gnatbind -u0 file
@end example @end example
@end quotation @end quotation
With this option, at each task termination, its stack usage is output on With this option, at each task termination, its stack usage is output on
@code{stderr}. @code{stderr}.
Note that this switch is not compatible with tools like
Valgrind and DrMemory; they will report errors.
It is not always convenient to output the stack usage when the program It is not always convenient to output the stack usage when the program
is still running. Hence, it is possible to delay this output until program is still running. Hence, it is possible to delay this output until program
termination. for a given number of tasks specified as the argument of the termination. for a given number of tasks specified as the argument of the
......
...@@ -67,6 +67,11 @@ package System.Stack_Usage is ...@@ -67,6 +67,11 @@ package System.Stack_Usage is
-- Type of the stack analyzer tool. It is used to fill a portion of the -- Type of the stack analyzer tool. It is used to fill a portion of the
-- stack with Pattern, and to compute the stack used after some execution. -- stack with Pattern, and to compute the stack used after some execution.
-- Note that Fill_Stack writes data past the current top of the stack
-- (i.e. at addresses less than the stack pointer register, assuming the
-- stack grows downward). Therefore, this package is incompatible with
-- tools like Valgrind and DrMemory.
-- Usage: -- Usage:
-- A typical use of the package is something like: -- A typical use of the package is something like:
......
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