pub_tool_oset.h and m_oset.c cleanup
* Remove dead code in m_oset.c VG_(OSetGen_ResetIterAt)
The code at the end of VG_(OSetGen_ResetIterAt) was unreachable
(detected by BEAM checker).
Looking at SVN, the initial commit of VG_(OSetGen_ResetIterAt)
already contained this deadcode.
* pub_tool_oset.h was wrongly indicating that signed words could
be used for fast cmp oset.
* modified memcheck/tests/unit_oset.c to test VG_(OSetGen_ResetIterAt)
* modified memcheck/tests/unit_oset.c to not use signed words
(it was previously using signed words, but only with positive values)
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@13622 a5019735-40e9-0310-863c-91ae7b9d1cf9
diff --git a/include/pub_tool_oset.h b/include/pub_tool_oset.h
index a22bda6..29d0254 100644
--- a/include/pub_tool_oset.h
+++ b/include/pub_tool_oset.h
@@ -56,9 +56,12 @@
// function even a (non-overlapping) interval list can be created. But
// the cost of calling a function for every comparison can be high during
// lookup. If no comparison function is provided, we assume that keys are
-// (signed or unsigned) words, and that the key is the first word in each
+// unsigned words, and that the key is the first word in each
// element. This fast comparison is suitable for an OSet containing
// structs where the first element is an Addr, for example.
+// Do not assume fast comparison works properly with signed words.
+// A.o. iterating over the values will not return them in the correct
+// order.
//
// Each OSet interface also has an iterator, which makes it simple to
// traverse all the nodes in order. Note that the iterator maintains state
@@ -228,7 +231,7 @@
// If there are several OSet managing similar such elements, it might be
// interesting to use a shared pool for these OSet.
// To have multiple OSets sharing a pool allocator, create the first OSet
-// with VG_(OSetGen_Create). Create subsequent OSet with
+// with VG_(OSetGen_Create_With_Pool). Create subsequent OSet with
// VG_(OSetGen_EmptyClone).
extern void VG_(OSetGen_Destroy) ( OSet* os );