maint: consolidate developer debug messages

[platform/upstream/coreutils.git] / README-valgrind

diff --git a/README-valgrind b/README-valgrind
index d3989a7..693effa 100644 (file)
--- a/README-valgrind
+++ b/README-valgrind
@@ -1,25 +1,52 @@
 #! /bin/bash
+# Convert this package for use with valgrind.
+
+# Copyright (C) 2002-2013 Free Software Foundation, Inc.
+
+# 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 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# 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, see <http://www.gnu.org/licenses/>.
+
 
-# Fix valgrind script to exec "$@", not some var.
-# Fix valgrind sources to know about syscall 252, for exit_group
 
 # Convert Makefile.am files:
-#  find tests -name Makefile.am \
-#    | xargs grep -wl PATH|xargs perl -pi -e 's,src:\$\$PATH,src/vg:\$\$PATH,'
+#  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 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 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 ' '  '))
-mkdir src/vg
+coreutils=$(echo 'spy:;@echo $(all_programs) $(noinst_PROGRAMS)' |
+            (cd src; make -f Makefile -f - spy | tr -s '\n ' '  '))
+mkdir -p src/vg
 pwd=`pwd`
-up=`dirname $pwd`
-path='export PATH='$up':${PATH#*:}'
-pre='#!/bin/sh\n'"$path"'\n'
-n=9
-vg='exec /p/bin/valgrind --quiet --num-callers='$n
+srcdir=$pwd/src
+_path='export PATH='$srcdir':${PATH#*:}'
+pre='#!/bin/sh\n'"$_path"'\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
+  printf "$pre$vg -- \$i"' "\$@"\n' > \$i
   chmod a+x \$i
 done
 EOF