Removing the example tool 'example' -- it's almost identical to Nulgrind,

except it doesn't actually get built and so ex_main.c and the Makefile.am tend
to get out of date.  Changed the docs to refer to Nulgrind as the example tool
for if you start writing a new one.

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

diff --git a/coregrind/docs/coregrind_tools.html b/coregrind/docs/coregrind_tools.html
index 17927bd75efe8954f2dfc884bfa04e2aa201dda5..7fc0b5381c6bcb77aec286e79d5ba38f631eb710 100644 (file)
--- a/coregrind/docs/coregrind_tools.html
+++ b/coregrind/docs/coregrind_tools.html
@@ -347,10 +347,10 @@ In what follows, all filenames are relative to Valgrind's top-level directory
   <li>Make a new directory <code>foobar/</code> which will hold the tool.
   </li><p>
 
-  <li>Copy <code>example/Makefile.am</code> into <code>foobar/</code>.
+  <li>Copy <code>none/Makefile.am</code> into <code>foobar/</code>.
       Edit it by replacing all occurrences of the string
-      ``<code>example</code>'' with ``<code>foobar</code>'' and the one
-      occurrence of the string ``<code>ex_</code>'' with ``<code>fb_</code>''.
+      ``<code>none</code>'' with ``<code>foobar</code>'' and the one
+      occurrence of the string ``<code>nl_</code>'' with ``<code>fb_</code>''.
       It might be worth trying to understand this file, at least a little;  you
       might have to do more complicated things with it later on.  In
       particular, the name of the <code>vgskin_foobar_so_SOURCES</code> variable
@@ -358,9 +358,9 @@ In what follows, all filenames are relative to Valgrind's top-level directory
       name must be passed to the <code>--tool</code> option to use the tool.
   </li><p>
 
-  <li>Copy <code>example/ex_main.c</code> into
+  <li>Copy <code>none/nl_main.c</code> into
       <code>foobar/</code>, renaming it as <code>fb_main.c</code>.
-      Edit it by changing the five lines in <code>SK_(pre_clo_init)()</code>
+      Edit it by changing the lines in <code>SK_(pre_clo_init)()</code>
       to something appropriate for the tool.  These fields are used in the
       startup message, except for <code>bug_reports_to</code> which is used
       if a tool assertion fails.

diff --git a/example/Makefile.am b/example/Makefile.am
deleted file mode 100644 (file)
index 513eb0d..0000000
--- a/example/Makefile.am
+++ /dev/null
@@ -1,20 +0,0 @@
-
-SUBDIRS = .
-
-AM_CPPFLAGS = -I$(top_srcdir)/include
-AM_CFLAGS = $(WERROR) -Winline -Wall -Wshadow -O -fomit-frame-pointer \
-               @PREFERRED_STACK_BOUNDARY@ -g
-
-valdir = $(libdir)/valgrind
-inplacedir = $(top_builddir)/.in_place
-
-val_PROGRAMS = vgskin_example.so
-
-vgskin_example_so_SOURCES = ex_main.c
-vgskin_example_so_LDFLAGS = -shared
-
-all-local:
-       mkdir -p $(inplacedir)
-       -rm -f $(addprefix $(inplacedir)/,$(val_PROGRAMS))
-       ln -f -s $(addprefix $(top_builddir)/$(subdir)/,$(val_PROGRAMS)) $(inplacedir)
-

diff --git a/example/ex_main.c b/example/ex_main.c
deleted file mode 100644 (file)
index c2b3024..0000000
--- a/example/ex_main.c
+++ /dev/null
@@ -1,63 +0,0 @@
-
-/*--------------------------------------------------------------------*/
-/*--- An example tool.                                   ex_main.c ---*/
-/*--------------------------------------------------------------------*/
-
-/*
-   This file is part of Valgrind, an extensible x86 protected-mode
-   emulator for monitoring program execution on x86-Unixes.
-
-   Copyright (C) 2002-2004 Nicholas Nethercote
-      njn25@cam.ac.uk
-
-   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 (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, write to the Free Software
-   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
-   02111-1307, USA.
-
-   The GNU General Public License is contained in the file COPYING.
-*/
-
-#include "vg_skin.h"
-
-static void SK_(pre_clo_init)()
-{
-   VG_(details_name)            ("Example");
-   VG_(details_version)         ("0.0.1");
-   VG_(details_description)     ("an example Valgrind tool");
-   VG_(details_copyright_author)(
-      "Copyright (C) 2002-2004, and put in the public domain, by Santa Claus.");
-   VG_(details_bug_reports_to)  ("santa.claus@northpole.org");
-
-   /* No needs, no core events to track */
-}
-
-void SK_(post_clo_init)(void)
-{
-}
-
-UCodeBlock* SK_(instrument)(UCodeBlock* cb, Addr a)
-{
-    return cb;
-}
-
-void SK_(fini)(exitcode)
-{
-}
-
-/* Does not use shadow memory */
-VG_DETERMINE_INTERFACE_VERSION(SK_(pre_clo_init), 0)
-
-/*--------------------------------------------------------------------*/
-/*--- end                                                ex_main.c ---*/
-/*--------------------------------------------------------------------*/