maint: consolidate developer debug messages
[platform/upstream/coreutils.git] / README-valgrind
index 5d8a8a3..693effa 100644 (file)
@@ -1,11 +1,11 @@
 #! /bin/bash
 # Convert this package for use with valgrind.
 
-# Copyright (C) 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
+# Copyright (C) 2002-2013 Free Software Foundation, Inc.
 
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
+# the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 
 # This program is distributed in the hope that it will be useful,
 # GNU General Public License for more details.
 
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-# 02110-1301, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
 
 # Convert Makefile.am files:
-#  find tests -name Makefile.am | xargs grep -wl PATH|xargs perl -pi -e \
-#    's,src(\$\(PATH_SEPARATOR\)\$\$PATH),src/vg$1,'
+#  find tests -name check.mk | xargs grep -wl PATH |
+#    xargs perl -pi -e 's,src(\$\(PATH_SEPARATOR\)),src/vg$1,'
 # To restore:
-# find tests -name Makefile.am|xargs grep -wl PATH|xargs perl -pi -e 's,src/vg,src,'
+#  find tests -name check.mk | xargs grep -wl PATH |
+#    xargs perl -pi -e 's,src/vg,src,'
 #
 # Create this symlink for suppressions (this is no longer necessary,
-# with linux-2.6.9 and valgrind-2.2.0):
+# with Linux kernel 2.6.9 and valgrind-2.2.0):
 # ln -s $PWD/.vg-suppressions /tmp/cu-vg
 
+
 # Create src/vg:
 
-coreutils=$(echo 'spy:;@echo $(all_programs)' | (cd src; make -f Makefile -f - spy | tr -s '\n ' '  '))
+coreutils=$(echo 'spy:;@echo $(all_programs) $(noinst_PROGRAMS)' |
+            (cd src; make -f Makefile -f - spy | tr -s '\n ' '  '))
 mkdir -p src/vg
 pwd=`pwd`
 srcdir=$pwd/src
 _path='export PATH='$srcdir':${PATH#*:}'
 pre='#!/bin/sh\n'"$_path"'\n'
-n=15
-vg='exec /usr/bin/valgrind --suppressions=/tmp/cu-vg --log-fd=3 --leak-check=yes --track-fds=yes --leak-check=full --num-callers='$n
+n=15 # stack trace depth
+log_fd=3 # One can redirect this to file like 3>vg.log
+test -e /tmp/cu-vg && suppressions='--supressions=/tmp/cu-vg'
+vg="exec /usr/bin/valgrind $suppressions --log-fd=$log_fd \
+--leak-check=yes --track-fds=yes --leak-check=full --num-callers=$n"
 cat <<EOF > src/vg/gen
 for i in $coreutils; do
   printf "$pre$vg -- \$i"' "\$@"\n' > \$i