[gcc r13-495] [Ada] GNAT.Debug_Pools: Improve documentation of the Stack_Trace_Depth parameter

[gcc r13-495] [Ada] GNAT.Debug_Pools: Improve documentation of the Stack_Trace_Depth parameter

[Pierre-Marie de Rodat]

https://gcc.gnu.org/g:f29e9e88965ade628873182a866bb26830994217

commit r13-495-gf29e9e88965ade628873182a866bb26830994217
Author: Joel Brobecker <brobecker@adacore.com>
Date:   Mon Mar 14 07:54:02 2022 +0400

    [Ada] GNAT.Debug_Pools: Improve documentation of the Stack_Trace_Depth parameter
    
    Setting this parameter to zero when calling the Configure procedure has
    the effect of disabling completely the tracking of the biggest memory
    users, which wasn't clear from the current documentation.  So this patch
    enhances the documentation of both the Configure procedure as well as
    the Dump procedure to make that explicit.
    
    gcc/ada/
    
            * libgnat/g-debpoo.ads: Improve documentation of the
            Stack_Trace_Depth parameter.

Diff:
---
 gcc/ada/libgnat/g-debpoo.ads | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/gcc/ada/libgnat/g-debpoo.ads b/gcc/ada/libgnat/g-debpoo.ads
index bf21369729a..e3df752abd1 100644
--- a/gcc/ada/libgnat/g-debpoo.ads
+++ b/gcc/ada/libgnat/g-debpoo.ads
@@ -123,7 +123,8 @@ package GNAT.Debug_Pools is
    --    traces that are output to indicate locations of actions for error
    --    conditions such as bad allocations. If set to zero, the debug pool
    --    will not try to compute backtraces. This is more efficient but gives
-   --    less information on problem locations
+   --    less information on problem locations (and in particular, this
+   --    disables the tracking of the biggest users of memory).
    --
    --    Maximum_Logically_Freed_Memory: maximum amount of memory (bytes)
    --    that should be kept before starting to physically deallocate some.
@@ -275,8 +276,12 @@ package GNAT.Debug_Pools is
       Size   : Positive;
       Report : Report_Type := All_Reports);
    --  Dump information about memory usage.
-   --  Size is the number of the biggest memory users we want to show. Report
-   --  indicates which sorting order is used in the report.
+   --  Size is the number of the biggest memory users we want to show
+   --  (requires that the Debug_Pool has been configured with Stack_Trace_Depth
+   --  greater than zero). Also, for efficiency reasons, tracebacks with
+   --  a memory allocation below 1_000 bytes are not shown in the "biggest
+   --  memory users" part of the report.
+   --  Report indicates which sorting order is used in the report.
 
    procedure Dump_Stdout
      (Pool   : Debug_Pool;