From: Nicholas Nethercote Date: Mon, 23 Aug 2004 14:15:29 +0000 (+0000) Subject: Removing the example tool 'example' -- it's almost identical to Nulgrind, X-Git-Tag: svn/VALGRIND_2_2_0~37 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=538305709fb8355dffc1354a6416e644bf629665;p=thirdparty%2Fvalgrind.git 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 17927bd75e..7fc0b5381c 100644 --- 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
  • Make a new directory foobar/ which will hold the tool.

    • -

  • Copy example/Makefile.am into foobar/. +
  • Copy none/Makefile.am into foobar/. Edit it by replacing all occurrences of the string - ``example'' with ``foobar'' and the one - occurrence of the string ``ex_'' with ``fb_''. + ``none'' with ``foobar'' and the one + occurrence of the string ``nl_'' with ``fb_''. 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 vgskin_foobar_so_SOURCES variable @@ -358,9 +358,9 @@ In what follows, all filenames are relative to Valgrind's top-level directory name must be passed to the --tool option to use the tool.

    • -

  • Copy example/ex_main.c into +
  • Copy none/nl_main.c into foobar/, renaming it as fb_main.c. - Edit it by changing the five lines in SK_(pre_clo_init)() + Edit it by changing the lines in SK_(pre_clo_init)() to something appropriate for the tool. These fields are used in the startup message, except for bug_reports_to which is used if a tool assertion fails. diff --git a/example/Makefile.am b/example/Makefile.am deleted file mode 100644 index 513eb0d49e..0000000000 --- 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 index c2b3024ed4..0000000000 --- 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 ---*/ -/*--------------------------------------------------------------------*/