Commit Graph

25 Commits

Author SHA1 Message Date
Josef Weidendorfer
ca4dc72ef9 Added some text for --simulate-wb/--cacheuse options of Callgrind.
For cacheuse, it actually got quite large...

git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10729
2009-08-06 18:13:17 +00:00
Nicholas Nethercote
d570c48793 Clean up Callgrind docs. Josef, I added brief entries for --collect-systime,
--cacheuse and --simulate-wb but you might like to expand them.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10728
2009-08-06 02:30:26 +00:00
Nicholas Nethercote
acd9f85b48 - Remove unused Callgrind documentation entities.
- Link to Cachegrind docs within the current set, not the version on the
  website.



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10726
2009-08-06 00:46:59 +00:00
Nicholas Nethercote
c4dbcca8b5 Remove man-callgrind.xml, because Callgrind no longer has a separate man
page (it hasn't for a long time).



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10725
2009-08-06 00:31:28 +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
74c920d729 Overhaul Massif's manual, and a few minor related things.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10706
2009-08-04 05:59:46 +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
Nicholas Nethercote
2913b0fa2d Remove callgrind/docs/index.xml, which is a relic from when Callgrind was
distributed by itself.



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10283
2009-06-09 22:25:00 +00:00
Nicholas Nethercote
99f13531ec Remove references to the now-defunct INSTALL file.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10271
2009-06-06 21:54:59 +00:00
Josef Weidendorfer
f7757e3ac6 Callgrind manual: add section on client requests and note about fork().
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@8705
2008-10-24 18:50:04 +00:00
Josef Weidendorfer
094c96388c Update old (and wrong) parts of callgrind documentation.
This obviously was already wrong in 3.2.x :-(

* Old --fn-recursion=... / --fn-caller=... options are called
  --separate-recs=... / --separate-callers=... since quite some
  time for consistency with e.g. --separate-threads=yes.
  Error noted from bug 153335.
* Function specifications support wildcards since quite some time;
  specification of a prefix only does not work, but the full
  function has to match. This was needed to allow to specify 'foo'
  without also specifying 'foo1'.
* The script 'callgrind' does not exist since merging into
  valgrind.
* Rename callgrind from being a 'heavyweight' to a 'call graph'
  profiler, similar to the description in the quick start overview.



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@7272
2007-12-04 10:09:24 +00:00
Josef Weidendorfer
1752567fb4 callgrind: support for --callgrind-out-file
This removes the --base option, which is replaced by
--callgrind-out-file.
Plus manual update.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@7235
2007-11-27 01:27:12 +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
Josef Weidendorfer
21ca947f50 callgrind: fix example description and clarification of callgrind format
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@6790
2007-08-28 21:52:45 +00:00
Josef Weidendorfer
a09042a627 Callgrind manual: Fix typo
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@6748
2007-05-24 20:42:41 +00:00
Josef Weidendorfer
833c095f5c Callgrind manual: rewriting start of section about avoding cycles
This hopefully makes the whole issue with cycles easier to understand.
And no, this does not get rid of the description of cycles, carefully
crafted by Julian ;-)


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@6747
2007-05-24 19:24:23 +00:00
Josef Weidendorfer
6575e93f46 Callgrind format: Note about event names in the example
The added paragraph was triggered by a question on the mailing list.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@6746
2007-05-24 18:04:42 +00:00
Julian Seward
b91b51b42b Merge (from 3.2 branch) r6743 (Edit the manual to bring it up to date
and make some of the wording a bit more professional sounding.)



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@6745
2007-05-23 21:58:33 +00:00
Josef Weidendorfer
db1e230c31 Callgrind: improve documentation
* Looks a little bit more like the Cachegrind manual
  (at least in front)
* Removed the out-of-place general section about profiling
  and gprof. Perhaps something like this can be put at
  another place
* Notes about Callgrinds problems with call tracing on PPC
* Include usage of callgrind_annotate, and note its lack of
  cycle detection


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@6734
2007-05-08 11:58:23 +00:00
Josef Weidendorfer
9f24ba3822 Correction: Callgrind got rid of the wrapper script with
the merge into Valgrind


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5972
2006-06-09 11:44:03 +00:00
Julian Seward
00b4d31826 Various minor edits.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5929
2006-05-25 18:37:25 +00:00
Josef Weidendorfer
61068ab73d Option --dump-every-bb now takes a 64bit value on user
request. Update/clarify documentation.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5806
2006-03-31 13:16:15 +00:00
Josef Weidendorfer
1cdac21bd9 Callgrind merge: documentation
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5781
2006-03-20 10:29:30 +00:00
Josef Weidendorfer
a3b8d67b91 Callgrind merge: code
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5780
2006-03-20 10:27:30 +00:00