Comment only changes.

* Clarify in the dedup pool comments that all bytes of elements are compared.
* pub_core_options.h : remove old/misplaced comment for clo_trace_children
                       and replace by a more clear comment (matching the --help)

git-svn-id: svn://svn.valgrind.org/valgrind/trunk@14704

diff --git a/coregrind/pub_core_options.h b/coregrind/pub_core_options.h
index b1ace2de29361342d2ada5ed22eee45c5427f694..de2adf24c13edf0ad05c8216bdee2ece365ffe65 100644 (file)
--- a/coregrind/pub_core_options.h
+++ b/coregrind/pub_core_options.h
@@ -93,11 +93,11 @@ extern Int   VG_(clo_gen_suppressions);
 extern Int   VG_(clo_sanity_level);
 /* Automatically attempt to demangle C++ names?  default: YES */
 extern Bool  VG_(clo_demangle);
-/* Simulate child processes? default: NO */
 /* Soname synonyms : a string containing a list of pairs
    xxxxx=yyyyy separated by commas.
    E.g. --soname-synonyms=somalloc=libtcmalloc*.so*,solibtruc=NONE */
 extern const HChar* VG_(clo_soname_synonyms);
+/* Valgrind-ise child processes (follow execve)? default : NO */
 extern Bool  VG_(clo_trace_children);
 /* String containing comma-separated patterns for executable names
    that should not be traced into even when --trace-children=yes */

diff --git a/include/pub_tool_deduppoolalloc.h b/include/pub_tool_deduppoolalloc.h
index ba239bf4a321f596fcde4c6ddf36df07f2da0b5c..e8f8e559b9049299886d5dad82a179ab2c5a3aa6 100644 (file)
--- a/include/pub_tool_deduppoolalloc.h
+++ b/include/pub_tool_deduppoolalloc.h
@@ -94,12 +94,19 @@ extern DedupPoolAlloc* VG_(newDedupPA) ( SizeT  poolSzB,
                                          void   (*free_fn)(void*) );
 
 /* Allocates a new element from ddpa with eltSzB bytes to store elt.
-   This function never returns NULL. */
+   This function never returns NULL.
+   If ddpa already contains an element equal to elt, then the address of
+   the already existing element is returned.
+   Equality between elements is done by comparing all bytes.
+   So, if void *elt points to a struct, be sure to initialise all components
+   and the holes between components. */
 extern const void* VG_(allocEltDedupPA) (DedupPoolAlloc *ddpa,
                                          SizeT eltSzB, const void *elt);
 
 /* Allocates a new (fixed size) element from ddpa. Returns the
-   unique number identifying this element. This function never returns NULL. */
+   unique number identifying this element. This function never returns NULL.
+   Similarly to VG_(allocEltDedupPA), this will return the unique number
+   of an already existing identical element to elt. */
 extern UInt VG_(allocFixedEltDedupPA) (DedupPoolAlloc *ddpa,
                                        SizeT eltSzB, const void *elt);