Remove some unnecessary #includes, comment some others.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@3968 a5019735-40e9-0310-863c-91ae7b9d1cf9
diff --git a/coregrind/m_debuginfo/dwarf.c b/coregrind/m_debuginfo/dwarf.c
index 2e77dd7..7721001 100644
--- a/coregrind/m_debuginfo/dwarf.c
+++ b/coregrind/m_debuginfo/dwarf.c
@@ -34,6 +34,7 @@
#include "pub_core_libcprint.h"
#include "pub_core_mallocfree.h"
#include "pub_core_options.h"
+
#include "priv_symtab.h"
diff --git a/coregrind/m_debuginfo/stabs.c b/coregrind/m_debuginfo/stabs.c
index 3540695..db0816b 100644
--- a/coregrind/m_debuginfo/stabs.c
+++ b/coregrind/m_debuginfo/stabs.c
@@ -33,6 +33,7 @@
#include "pub_core_libcassert.h"
#include "pub_core_libcprint.h"
#include "pub_core_mallocfree.h"
+
#include "priv_symtab.h"
#include <a.out.h> /* stabs defns */
diff --git a/coregrind/m_debuginfo/symtab.c b/coregrind/m_debuginfo/symtab.c
index a381162..a55e289 100644
--- a/coregrind/m_debuginfo/symtab.c
+++ b/coregrind/m_debuginfo/symtab.c
@@ -31,7 +31,8 @@
#include "pub_core_basics.h"
#include "pub_core_threadstate.h"
-#include "pub_core_aspacemgr.h"
+#include "pub_core_aspacemgr.h" // For Segment type
+#include "pub_core_debuginfo.h"
#include "pub_core_demangle.h"
#include "pub_core_libcbase.h"
#include "pub_core_libcassert.h"
@@ -43,7 +44,7 @@
#include "pub_core_options.h"
#include "pub_core_profile.h"
#include "pub_core_redir.h"
-#include "pub_core_tooliface.h"
+#include "pub_core_tooliface.h" // For VG_(needs).data_syms
#include "priv_symtab.h"
#include <elf.h> /* ELF defns */
diff --git a/coregrind/m_debuginfo/symtypes.c b/coregrind/m_debuginfo/symtypes.c
index 6147a7f..fcf7f61 100644
--- a/coregrind/m_debuginfo/symtypes.c
+++ b/coregrind/m_debuginfo/symtypes.c
@@ -30,7 +30,7 @@
#include "pub_core_basics.h"
#include "pub_core_debuginfo.h"
-#include "pub_core_debuglog.h" /* VG_(debugLog_vprintf) */
+#include "pub_core_debuglog.h" // For VG_(debugLog_vprintf)
#include "pub_core_libcbase.h"
#include "pub_core_libcassert.h"
#include "pub_core_libcmman.h"
@@ -38,7 +38,7 @@
#include "pub_core_libcsignal.h"
#include "pub_core_machine.h"
#include "pub_core_mallocfree.h"
-#include "pub_core_tooliface.h"
+
#include "priv_symtypes.h"
typedef enum {
diff --git a/coregrind/m_scheduler/scheduler.c b/coregrind/m_scheduler/scheduler.c
index a5c6c2d..1ae50a1 100644
--- a/coregrind/m_scheduler/scheduler.c
+++ b/coregrind/m_scheduler/scheduler.c
@@ -64,7 +64,7 @@
#include "pub_core_threadstate.h"
#include "pub_core_aspacemgr.h"
#include "pub_core_dispatch.h"
-#include "pub_core_errormgr.h"
+#include "pub_core_errormgr.h" // For VG_(get_n_errs_found)()
#include "pub_core_libcbase.h"
#include "pub_core_libcassert.h"
#include "pub_core_libcprint.h"
@@ -77,11 +77,11 @@
#include "pub_core_replacemalloc.h"
#include "pub_core_scheduler.h"
#include "pub_core_signals.h"
-#include "pub_core_stacktrace.h"
+#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"
-#include "pub_core_translate.h"
+#include "pub_core_translate.h" // For VG_(translate)()
#include "pub_core_transtab.h"
#include "vki_unistd.h"
#include "priv_sema.h"
diff --git a/coregrind/m_scheduler/sema.c b/coregrind/m_scheduler/sema.c
index 0d12923..d3d30cf 100644
--- a/coregrind/m_scheduler/sema.c
+++ b/coregrind/m_scheduler/sema.c
@@ -31,7 +31,7 @@
#include "pub_core_basics.h"
#include "pub_core_libcassert.h"
#include "pub_core_libcfile.h"
-#include "pub_core_libcproc.h"
+#include "pub_core_libcproc.h" // For VG_(gettid)()
#include "priv_sema.h"
/*
diff --git a/coregrind/m_syswrap/syswrap-generic.c b/coregrind/m_syswrap/syswrap-generic.c
index 44e4ba1..4b516c2 100644
--- a/coregrind/m_syswrap/syswrap-generic.c
+++ b/coregrind/m_syswrap/syswrap-generic.c
@@ -35,13 +35,13 @@
#include "pub_core_libcbase.h"
#include "pub_core_libcassert.h"
#include "pub_core_libcfile.h"
-#include "pub_core_libcmman.h"
+#include "pub_core_libcmman.h" // For VG_(mmap), VG_(munmap)()
#include "pub_core_libcprint.h"
#include "pub_core_libcproc.h"
#include "pub_core_libcsignal.h"
#include "pub_core_main.h"
#include "pub_core_mallocfree.h"
-#include "pub_core_stacktrace.h"
+#include "pub_core_stacktrace.h" // For VG_(get_and_pp_StackTrace)()
#include "pub_core_tooliface.h"
#include "pub_core_options.h"
#include "pub_core_scheduler.h"
diff --git a/coregrind/m_syswrap/syswrap-linux.c b/coregrind/m_syswrap/syswrap-linux.c
index 00af0fe..d915ea6 100644
--- a/coregrind/m_syswrap/syswrap-linux.c
+++ b/coregrind/m_syswrap/syswrap-linux.c
@@ -41,7 +41,7 @@
#include "pub_core_tooliface.h"
#include "pub_core_options.h"
#include "pub_core_scheduler.h"
-#include "pub_core_signals.h"
+#include "pub_core_signals.h" // For VG_(client_signal_OK)()
#include "pub_core_syscall.h"
#include "priv_types_n_macros.h"
diff --git a/coregrind/m_syswrap/syswrap-main.c b/coregrind/m_syswrap/syswrap-main.c
index c26e1d7..56f1a8e 100644
--- a/coregrind/m_syswrap/syswrap-main.c
+++ b/coregrind/m_syswrap/syswrap-main.c
@@ -34,13 +34,14 @@
#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_(getpid)()
#include "pub_core_libcsignal.h"
-#include "pub_core_scheduler.h"
-#include "pub_core_stacktrace.h"
+#include "pub_core_scheduler.h" // For VG_(set_sleeping), VG_(set_running),
+ // and VG_(vg_yield)
+#include "pub_core_stacktrace.h" // For VG_(get_and_pp_StackTrace)()
#include "pub_core_tooliface.h"
#include "pub_core_options.h"
-#include "pub_core_signals.h"
+#include "pub_core_signals.h" // For VG_(max_signal), VG_(poll_signals)
#include "pub_core_syscall.h"
#include "pub_core_syswrap.h"
diff --git a/coregrind/m_syswrap/syswrap-x86-linux.c b/coregrind/m_syswrap/syswrap-x86-linux.c
index 5168e21..bc2ee3e 100644
--- a/coregrind/m_syswrap/syswrap-x86-linux.c
+++ b/coregrind/m_syswrap/syswrap-x86-linux.c
@@ -37,17 +37,17 @@
#include "pub_core_threadstate.h"
#include "pub_core_debuglog.h"
#include "pub_core_aspacemgr.h"
-#include "pub_core_options.h"
#include "pub_core_libcbase.h"
#include "pub_core_libcassert.h"
#include "pub_core_libcmman.h"
#include "pub_core_libcprint.h"
#include "pub_core_libcproc.h"
#include "pub_core_libcsignal.h"
-#include "pub_core_main.h"
+#include "pub_core_main.h" // For VG_(shutdown_actions_NORETURN)()
#include "pub_core_mallocfree.h"
+#include "pub_core_options.h"
#include "pub_core_scheduler.h"
-#include "pub_core_sigframe.h"
+#include "pub_core_sigframe.h" // For VG_(sigframe_destroy)()
#include "pub_core_signals.h"
#include "pub_core_syscall.h"
#include "pub_core_syswrap.h"