33 Commits

Author SHA1 Message Date
Julian Seward
7067169d52 Documentation updates for Helgrind.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@11828
2011-06-24 18:23:42 +00:00
Julian Seward
d77ef03457 Add free-is-write functionality (experimental, not enabled by default).
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@11627
2011-03-11 21:06:59 +00:00
Julian Seward
47be27ff77 Fix minor documentation nits (Michael Snyder, msnyder@vmware.com)
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@11577
2011-02-28 10:26:42 +00:00
Julian Seward
29a513828a Update the Helgrind manual for 3.5.0.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10829
2009-08-16 22:47:02 +00:00
Julian Seward
adbc233c4d Double the maximum size of the conflict cache.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10817
2009-08-14 21:33:34 +00:00
Nicholas Nethercote
4e495edf4a Make "option" terminology consistent some more. Also tweaked the mempool
Memcheck section a little.



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10759
2009-08-10 01:29:14 +00:00
Nicholas Nethercote
2169d23e04 Remove some text that shouldn't be there.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10737
2009-08-07 05:58:00 +00:00
Nicholas Nethercote
789339fe6f Overhaul Helgrind's manual chapter.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10731
2009-08-07 02:18:00 +00:00
Nicholas Nethercote
dbcea71779 More docs build tweaks:
- Actually remove the dead docs/images/massif*.png files (this was meant to
  happen in r10720).

- Inline $TOOL/docs/Makefile.am into $TOOL/Makefile.am for all 10 tools.  10
  fewer Makefile.am files FTW!


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10721
2009-08-05 08:08:18 +00:00
Nicholas Nethercote
d5b384f852 Various manual fix-ups:
- Use "heap blocks" rather than "malloc'd blocks" as heap blocks covers
  calloc, realloc, new, new[], memalign, etc.

- Used "GDB" and "GCC" throughout rather than "gcc" and "gdb".

- Made various tag uses more consistent.

- Greatly clarified the instructions on --xml=yes and its friends.

- Lots of other little improvements and fixes to out-of-date things and
  Linux-centric things, mostly in Section 2.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10701
2009-08-04 01:16:01 +00:00
Nicholas Nethercote
ac7761261a We currently use a mix of <option> and <computeroutput> tags for command
line options.  This commit changes them to all <option>.

Also make consistent how options with multiple names (eg. -h --help) are
shown.

Also, remove section describing --help and --version in Callgrind's chapter;
these aren't necessary and are presumably a hangover from when Callgrind was
a separate tool.



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10659
2009-07-30 02:57:52 +00:00
Nicholas Nethercote
78b2e5c83e Started overhauling the documentation:
- There were detailed descriptions of all the tools in the Quick Start
  Guide, the Manual introduction, and the start of each tool chapter.  To
  avoid duplication/overlap, I removed these altogether from the Quick Start
  Guide, and shortened them in the intro.

- Improved the description of what errors Memcheck can find.

- Made all tool chapters start with "Overview" section, for consistency.

- Made the "run with --tool=XXX" bit consistent in each tool chapter.

- Made all tool chapter titles match the description given when running them.

- Added BBV to the User Manual intro.

- Generally clarified, updated, and future-proofed various bits of text in
  the Quick Start Guide and User Manual introduction. 

Also:
- Changed Nulgrind's start-up description to "the minimal Valgrind tool".

- Fixed some punctuation in the usage message.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10652
2009-07-29 02:36:21 +00:00
Julian Seward
666f358d34 Minor futzing with the documentation.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@8871
2008-12-23 11:13:07 +00:00
Julian Seward
9736f313e4 Finish off updates to the Helgrind manual.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@8860
2008-12-22 00:39:41 +00:00
Julian Seward
a35a48f96e More documentation updates. Urr. I knew there was a reason I'd been
putting this off.



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@8859
2008-12-21 23:11:14 +00:00
Julian Seward
445305ada1 Partial update of the Helgrind documentation (incomplete).
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@8858
2008-12-21 21:17:24 +00:00
Bart Van Assche
a82e55b5c2 Fixed typo.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@8290
2008-06-27 19:25:35 +00:00
Julian Seward
47680cfc98 Correctly handle semaphores with nonzero initial values. Fixes bug
observed by Matthieu Castet.  Also, add another sanity-check flag.



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@7253
2007-11-30 11:11:02 +00:00
Julian Seward
5e2a8da202 Spelling fixes and misc tidying for the manual. (Brian Gough)
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@7173
2007-11-17 09:43:25 +00:00
Julian Seward
969c77b267 Rename in the manual.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@7130
2007-11-09 23:59:49 +00:00
Julian Seward
6109e89b04 Import thrcheck from the THRCHECK branch, and rename it Helgrind (with
permission of the existing Helgrind authors).



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@7116
2007-11-09 22:49:28 +00:00
Julian Seward
7d6046494a Rename this directory.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@7113
2007-11-09 15:44:15 +00:00
Donna Robinson
9888e86b06 Tidying up stuff re generating manpage from *.xml docs
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5277
2005-12-03 23:02:33 +00:00
Julian Seward
d07dbe4a52 Complete documentation trawl for 3.1.0.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5137
2005-11-15 20:56:23 +00:00
Donna Robinson
b655e45a8e argh! there were loads of the little beggars ....
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@3999
2005-06-23 00:17:51 +00:00
Nicholas Nethercote
7a75a9f583 Overhauled the docs. Removed all the HTML files, put in XML files as
converted by Donna.  Hooked it into the build system so they are only
built when specifically asked for, and when doing "make dist".

They're not perfect;  in particular, there are the following problems:
- The plain-text FAQ should be built from FAQ.xml, but this is not
  currently done.  (The text FAQ has been left in for now.)

- The PS/PDF building doesn't work -- it fails with an incomprehensible
  error message which I haven't yet deciphered.

Nonetheless, I'm putting it in so others can see it.



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@3153
2004-11-30 10:43:45 +00:00
Nicholas Nethercote
0db27515b1 Putting "dist_" in front of a "_DATA" variable means it is included in "make
dist".  This avoids the need to put it in "EXTRA_DIST", and saves a few lines
in all the docs Makefile.am files.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@2614
2004-08-25 11:40:07 +00:00
Nicholas Nethercote
fb2d543ee8 Started to rescind the name "skin", replacing it with "tool". Did this in all
the places that normal users will see:

  - command line: --tool=foo (although --skin=foo still works)
  - docs: removed all traces (included renaming coregrind_skins.html to
    coregrind_tools.html)
  - in the usage messages
  - in error messages

Also did in in some places that I judged were unlikely to cause clashes with
existing workspaces:

  - in the header comments of many files (eg. "This file is part of Memcheck, a
    Valgrind tool for...")
  - in the regtests script
  - in the .supp files
  - in AUTHORS
  - in README_MISSING_SYSCALL_OR_IOCTL

Also update the AUTHORS file to mention Jeremy.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@2027
2003-11-14 17:47:54 +00:00
Nicholas Nethercote
d870c8df8e Minor addition.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@1645
2003-05-20 17:41:24 +00:00
Julian Seward
0f6cf30022 Restructure the documentation to try and make it hang together better.
Majorly improved.  Still a lot to do, but the structure is better.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@1324
2002-11-18 00:07:28 +00:00
Julian Seward
5fd0ef7ca3 Just call me Mr Brain-Dead Moron. Move the documentation sources to
where I _should_ have put them in the first place, and fix up the
Makefile.am's accordingly.  'make' and 'make install' now work.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@1292
2002-11-13 21:24:57 +00:00
Julian Seward
50040b9ebc Delete all the old documentation ...
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@1283
2002-11-11 00:11:22 +00:00
Nicholas Nethercote
a43fe4a74c Added basic docs for Helgrind, Lackey, CoreCheck.
Minor wibbles in AUTHORS.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@1170
2002-10-03 10:07:34 +00:00