From 4b7fc0d416ff3952318eb17ec48fe83b1b59275e Mon Sep 17 00:00:00 2001 From: Tom Hughes Date: Fri, 4 Nov 2005 12:27:58 +0000 Subject: [PATCH] Remove remaining references to the old tool.h header. git-svn-id: svn://svn.valgrind.org/valgrind/trunk@4998 --- docs/xml/writing-tools.xml | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/xml/writing-tools.xml b/docs/xml/writing-tools.xml index a6ff41ec05..cd74ea055c 100644 --- a/docs/xml/writing-tools.xml +++ b/docs/xml/writing-tools.xml @@ -23,9 +23,7 @@ profiling. quite a few things about Valgrind, it is much easier than instrumenting a program from scratch yourself. -[Nb: What follows is slightly out of date. In particular, -there are various references to a file include/tool.h which has been -split into a number of header files in include/.] +[Nb: What follows is slightly out of date.] @@ -572,25 +570,25 @@ quite complex and not brilliantly documented. Here are some important points, but there are undoubtedly many others that I should note but haven't thought of. -The file include/tool.h contains +The files include/pub_tool_*.h contain all the types, macros, functions, etc. that a tool should -(hopefully) need, and is the only .h file a -tool should need to +(hopefully) need, and are the only .h files +a tool should need to #include. In particular, you probably shouldn't use anything from the C library (there are deep reasons for this, trust us). Valgrind provides an implementation of a reasonable subset of the C library, details of which are in -tool.h. +pub_tool_libc*.h. Similarly, when writing a tool, you shouldn't need to look at any of the code in Valgrind's core. Although it might be useful sometimes to help understand something. -tool.h has a reasonable amount of -documentation in it that should hopefully be enough to get you -going. But ultimately, the tools distributed (Memcheck, +The pub_tool_*.h files have a reasonable +amount of documentation in it that should hopefully be enough to get +you going. But ultimately, the tools distributed (Memcheck, Addrcheck, Cachegrind, Lackey, etc.) are probably the best documentation of all, for the moment. -- 2.47.3