From: Nicholas Nethercote <njn@valgrind.org>
Date: Mon, 20 Jun 2005 03:36:51 +0000 (+0000)
Subject: Remove some unnecessary #includes, comment some others.
X-Git-Tag: svn/VALGRIND_3_0_0~352
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f4d8932fc839352cc705d51f369b08405618e8cf;p=thirdparty%2Fvalgrind.git

Remove some unnecessary #includes, comment some others.


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

diff --git a/coregrind/m_errormgr.c b/coregrind/m_errormgr.c
index 3a60fb9809..fe30e08b4e 100644
--- a/coregrind/m_errormgr.c
+++ b/coregrind/m_errormgr.c
@@ -29,7 +29,7 @@
 */
 
 #include "pub_core_basics.h"
-#include "pub_core_threadstate.h"
+#include "pub_core_threadstate.h"      // For VG_N_THREADS
 #include "pub_core_debugger.h"
 #include "pub_core_debuginfo.h"
 #include "pub_core_errormgr.h"
@@ -38,12 +38,11 @@
 #include "pub_core_libcassert.h"
 #include "pub_core_libcfile.h"
 #include "pub_core_libcprint.h"
-#include "pub_core_libcproc.h"
+#include "pub_core_libcproc.h"         // For VG_(getpid)()
 #include "pub_core_mallocfree.h"
 #include "pub_core_options.h"
-#include "pub_core_stacktrace.h"
 #include "pub_core_tooliface.h"
-#include "pub_core_translate.h"
+#include "pub_core_translate.h"        // for VG_(translate)()
 
 /*------------------------------------------------------------*/
 /*--- Globals                                              ---*/
diff --git a/coregrind/m_execontext.c b/coregrind/m_execontext.c
index 649e7467f6..2247359658 100644
--- a/coregrind/m_execontext.c
+++ b/coregrind/m_execontext.c
@@ -31,7 +31,7 @@
 #include "pub_core_basics.h"
 #include "pub_core_execontext.h"
 #include "pub_core_libcassert.h"
-#include "pub_core_libcprint.h"
+#include "pub_core_libcprint.h"     // For VG_(message)()
 #include "pub_core_mallocfree.h"
 #include "pub_core_options.h"
 #include "pub_core_profile.h"
diff --git a/coregrind/m_libcassert.c b/coregrind/m_libcassert.c
index 61504ab291..4f76565920 100644
--- a/coregrind/m_libcassert.c
+++ b/coregrind/m_libcassert.c
@@ -33,11 +33,11 @@
 #include "pub_core_libcbase.h"
 #include "pub_core_libcassert.h"
 #include "pub_core_libcprint.h"
-#include "pub_core_libcproc.h"
+#include "pub_core_libcproc.h"      // For VG_(gettid)()
 #include "pub_core_options.h"
 #include "pub_core_stacktrace.h"
 #include "pub_core_syscall.h"
-#include "pub_core_tooliface.h"
+#include "pub_core_tooliface.h"     // For VG_(details)
 #include "vki_unistd.h"
 
 /* ---------------------------------------------------------------------
diff --git a/coregrind/m_libcfile.c b/coregrind/m_libcfile.c
index 44dd086281..cc914349bf 100644
--- a/coregrind/m_libcfile.c
+++ b/coregrind/m_libcfile.c
@@ -34,7 +34,6 @@
 #include "pub_core_libcfile.h"
 #include "pub_core_libcprint.h"
 #include "pub_core_mallocfree.h"
-#include "pub_core_options.h"
 #include "pub_core_syscall.h"
 #include "vki_unistd.h"
 
diff --git a/coregrind/m_libcmman.c b/coregrind/m_libcmman.c
index 9270eef888..35db189f80 100644
--- a/coregrind/m_libcmman.c
+++ b/coregrind/m_libcmman.c
@@ -34,7 +34,6 @@
 #include "pub_core_libcassert.h"
 #include "pub_core_libcmman.h"
 #include "pub_core_libcprint.h"
-#include "pub_core_libcproc.h"
 #include "pub_core_syscall.h"
 #include "vki_unistd.h"
 
diff --git a/coregrind/m_libcprint.c b/coregrind/m_libcprint.c
index 88e5a7e904..9e55a94360 100644
--- a/coregrind/m_libcprint.c
+++ b/coregrind/m_libcprint.c
@@ -32,11 +32,11 @@
 #include "pub_core_debuglog.h"
 #include "pub_core_libcbase.h"
 #include "pub_core_libcassert.h"
-#include "pub_core_libcfile.h"
+#include "pub_core_libcfile.h"   // For VG_(write)(), VG_(write_socket)()
 #include "pub_core_libcprint.h"
-#include "pub_core_libcproc.h"
+#include "pub_core_libcproc.h"   // For VG_(getpid)()
 #include "pub_core_options.h"
-#include "valgrind.h"           // for RUNNING_ON_VALGRIND
+#include "valgrind.h"            // For RUNNING_ON_VALGRIND
 
 #include <time.h>
 #include <sys/time.h>
diff --git a/coregrind/m_redir.c b/coregrind/m_redir.c
index b3c99083e6..38cb8320ce 100644
--- a/coregrind/m_redir.c
+++ b/coregrind/m_redir.c
@@ -31,7 +31,7 @@
 */
 
 #include "pub_core_basics.h"
-#include "pub_core_aspacemgr.h"
+#include "pub_core_aspacemgr.h"     // Needed for pub_core_redir.h
 #include "pub_core_libcbase.h"
 #include "pub_core_libcassert.h"
 #include "pub_core_libcprint.h"
@@ -41,7 +41,7 @@
 #include "pub_core_skiplist.h"
 #include "pub_core_trampoline.h"
 #include "pub_core_transtab.h"
-#include "m_debuginfo/priv_symtab.h"  // XXX: bad!
+#include "m_debuginfo/priv_symtab.h"  // XXX: bad!  For SegInfo internals
 
 /*------------------------------------------------------------*/
 /*--- General purpose redirection.                         ---*/
diff --git a/coregrind/m_signals.c b/coregrind/m_signals.c
index a1a0fbcb9f..4c83d0074e 100644
--- a/coregrind/m_signals.c
+++ b/coregrind/m_signals.c
@@ -95,8 +95,8 @@
 #include "pub_core_options.h"
 #include "pub_core_scheduler.h"
 #include "pub_core_signals.h"
-#include "pub_core_sigframe.h"
-#include "pub_core_stacktrace.h"
+#include "pub_core_sigframe.h"      // For VG_(sigframe_create)()
+#include "pub_core_stacktrace.h"    // For VG_(get_and_pp_StackTrace)()
 #include "pub_core_syscall.h"
 #include "pub_core_syswrap.h"
 #include "pub_core_tooliface.h"
diff --git a/coregrind/m_stacktrace.c b/coregrind/m_stacktrace.c
index f9e80088c8..8b1f88dfd0 100644
--- a/coregrind/m_stacktrace.c
+++ b/coregrind/m_stacktrace.c
@@ -30,8 +30,7 @@
 
 #include "pub_core_basics.h"
 #include "pub_core_threadstate.h"
-#include "pub_core_aspacemgr.h"
-#include "pub_core_debuginfo.h"
+#include "pub_core_aspacemgr.h"     // For VG_(is_addressable)()
 #include "pub_core_libcbase.h"
 #include "pub_core_libcassert.h"
 #include "pub_core_libcprint.h"
@@ -267,5 +266,5 @@ void VG_(apply_StackTrace)( void(*action)(UInt n, Addr ip),
 
 
 /*--------------------------------------------------------------------*/
-/*--- end                                           m_stacktrace.c ---*/
+/*--- end                                                          ---*/
 /*--------------------------------------------------------------------*/
diff --git a/coregrind/m_translate.c b/coregrind/m_translate.c
index a964ad733e..c2babb3c65 100644
--- a/coregrind/m_translate.c
+++ b/coregrind/m_translate.c
@@ -37,9 +37,9 @@
 #include "pub_core_libcprint.h"
 #include "pub_core_options.h"
 #include "pub_core_profile.h"
-#include "pub_core_redir.h"
-#include "pub_core_signals.h"
-#include "pub_core_tooliface.h"
+#include "pub_core_redir.h"         // For VG_(code_redirect)()
+#include "pub_core_signals.h"       // For VG_(synth_fault_{perms,mapping})()
+#include "pub_core_tooliface.h"     // For VG_(tdict)
 #include "pub_core_translate.h"
 #include "pub_core_transtab.h"
 
diff --git a/coregrind/m_transtab.c b/coregrind/m_transtab.c
index a43453c22e..557a0050e9 100644
--- a/coregrind/m_transtab.c
+++ b/coregrind/m_transtab.c
@@ -30,15 +30,15 @@
 */
 
 #include "pub_core_basics.h"
-#include "pub_core_debuginfo.h"
+#include "pub_core_debuginfo.h"     // For VG_(get_fnname_w_offset)()
 #include "pub_core_libcbase.h"
 #include "pub_core_libcassert.h"
-#include "pub_core_libcmman.h"
+#include "pub_core_libcmman.h"      // For VG_(get_memory_from_mmap)()
 #include "pub_core_libcprint.h"
 #include "pub_core_options.h"
-#include "pub_core_tooliface.h"
+#include "pub_core_tooliface.h"     // For VG_(details).avg_translation_sizeB
 // XXX: this module should not depend on m_translate!
-#include "pub_core_translate.h"
+#include "pub_core_translate.h"     // For VG_(translate)()
 #include "pub_core_transtab.h"
 
 /* #define DEBUG_TRANSTAB */
diff --git a/coregrind/vg_preloaded.c b/coregrind/vg_preloaded.c
index d76267c3c0..bb79dc3cab 100644
--- a/coregrind/vg_preloaded.c
+++ b/coregrind/vg_preloaded.c
@@ -46,8 +46,8 @@
 #include "coregrind.h"
 
 #include "pub_core_basics.h"
-#include "pub_core_debuginfo.h"     // needed for pub_core_redir.h :(
-#include "pub_core_redir.h"
+#include "pub_core_debuginfo.h"  // Needed for pub_core_redir.h
+#include "pub_core_redir.h"      // For VG_NOTIFY_ON_LOAD
 
 /* ---------------------------------------------------------------------
    Hook for running __libc_freeres once the program exits.