27 Commits

Author SHA1 Message Date
Mark Wielaard
a2ef3fcf6a Explicitly set stylesheet to use with xmlto. 2020-05-15 12:30:00 +02:00
Mark Wielaard
5f4a5783aa Move to xmlto with fop for print-docs.
Default to using fop for pdf generation.
pdfxmltex is known to be broken by default.
xmlto can also use pdfxmltex or dblatex if available.
2020-05-15 01:12:44 +02:00
Nicholas Nethercote
441bfc5f51 Overhaul DHAT.
This commit thoroughly overhauls DHAT, moving it out of the
"experimental" ghetto. It makes moderate changes to DHAT itself,
including dumping profiling data to a JSON format output file. It also
implements a new data viewer (as a web app, in dhat/dh_view.html).

The main benefits over the old DHAT are as follows.

- The separation of data collection and presentation means you can run a
  program once under DHAT and then sort the data in various ways. Also,
  full data is in the output file, and the viewer chooses what to omit.

- The data can be sorted in more ways than previously. Some of these
  sorts involve useful filters such as "short-lived" and "zero reads or
  zero writes".

- The tree structure view avoids the need to choose stack trace depth.
  This avoids both the problem of not enough depth (when records that
  should be distinct are combined, and may not contain enough
  information to be actionable) and the problem of too much depth (when
  records that should be combined are separated, making them seem less
  important than they really are).

- Byte and block measures are shown with a percentage relative to the
  global count, which helps gauge relative significance of different
  parts of the profile.

- Byte and blocks measures are also shown with an allocation rate
  (bytes and blocks per million instructions), which enables comparisons
  across multiple profiles, even if those profiles represent different
  workloads.

- Both global and per-node measurements are taken at the global heap
  peak ("At t-gmax"), which gives Massif-like insight into the point of
  peak memory use.

- The final/liftimes stats are a bit more useful than the old deaths
  stats. (E.g. the old deaths stats didn't take into account lifetimes
  of unfreed blocks.)

- The handling of realloc() has changed. The sequence `p = malloc(100);
  realloc(p, 200);` now increases the total block count by 2 and the
  total byte count by 300. Previously it increased them by 1 and 200.
  The new handling is a more operational view that better reflects the
  effect of allocations on performance. It makes a significant
  difference in the results, giving paths involving reallocation (e.g.
  repeated pushing to a growing vector) more prominence.

Other things of note:

- There is now testing, both regression tests that run within the
  standard test suite, and viewer-specific tests that cannot run within
  the standard test suite. The latter are run by loading
  dh_view.html?test=1 in a web browser.

- The commit puts all tool lists in Makefiles (and similar files) in the
  following consistent order: memcheck, cachegrind, callgrind, helgrind,
  drd, massif, dhat, lackey, none; exp-sgcheck, exp-bbv.

- A lot of fields in dh_main.c have been given more descriptive names.
  Those names now match those used in dh_view.js.
2019-02-01 14:54:34 +11:00
Ivo Raisr
830d59718a Change Subversion to GIT in various places 2017-08-14 15:27:40 +02:00
Julian Seward
9deefb5e16 Update doc building notes for Fedora 25.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@16416
2017-05-24 15:24:16 +00:00
Julian Seward
43f0bfc6be Update for Fedora 21 and 22.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@15645
2015-09-08 12:53:49 +00:00
Florian Krohm
544aa45a0f Merge the contents of docs/internals/howto_build_documentation
into docs/README.
Remove the section about the XML Toolchain as it is outdated.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@15019
2015-03-16 22:42:13 +00:00
Julian Seward
65c29466e7 Add notes re new print docs build failures.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@12839
2012-08-05 14:25:35 +00:00
Nicholas Nethercote
e06f6f7164 Manpage improvements:
- Added a manpage for ms_print.

- Added docs/xml/manpages-index.xml, which is just used as a convenient
  single file to hang all the man pages off so they can be generated in a
  single command.

- Added facility whereby manpage generation will attempt to find the
  stylesheet in multiple places.  This means I don't have to constantly edit
  XSL_MAN_STYLE to build manpages on my machine.

- Changed vg-docs-path to start with $INSTALL instead of /usr/, because we
  can't assume that's the installation dir.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10740
2009-08-07 06:54:44 +00:00
Nicholas Nethercote
12e1a2d601 Minor update.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10727
2009-08-06 01:26:14 +00:00
Nicholas Nethercote
585caf2169 Add some info about building the docs on Ubuntu 9.04.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@9903
2009-05-18 23:11:49 +00:00
Julian Seward
8e8a7e5754 Very minor changes.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@7209
2007-11-25 00:56:51 +00:00
Julian Seward
0648e87955 Update notes.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@7106
2007-11-07 01:10:42 +00:00
Julian Seward
510e185899 Record which SuSE 10.1 packages are needed for a successful 'make dist'.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@6636
2007-03-08 19:56:58 +00:00
Julian Seward
c9d6e1c3af Update.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@6388
2006-12-10 02:58:27 +00:00
Donna Robinson
e53a6fba14 The valgrind manpage is now auto-generated directly from the
*.xml docs.  No more groffly/nroffly editing.
How cool is docbook ?



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5276
2005-12-03 22:33:29 +00:00
Donna Robinson
1b79f76040 Updated the README to reflect the current situation.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5253
2005-11-29 17:42:50 +00:00
Julian Seward
dfa3bfb64d Fixes to make the .pdf build using the toolchain on SuSE10 (from Donna).
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5171
2005-11-17 18:04:58 +00:00
Nicholas Nethercote
e41c7abfe2 Commit Jeroen Witmond's xml-to-text translator, and use it for the FAQ.
Less double maintenance, hoorah!



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@4830
2005-09-30 01:43:32 +00:00
Nicholas Nethercote
1de811dc15 update
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@4585
2005-08-30 03:12:57 +00:00
Julian Seward
281f0f1732 I'm still a moron (just in case anybody wondered whether things had
improved since last time I was a moron.  No, they haven't).

Move text that's supposed to be at the top of the file to the top of
the file.  I need to learn about these scroll-bar things some time.



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@4254
2005-07-25 17:58:48 +00:00
Julian Seward
aafc278acd Record my adventures in 'make print-docs' land.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@4253
2005-07-25 17:54:06 +00:00
Nicholas Nethercote
61448c507d We have a nice little collection of text files describing various high
level things.  But they're all over the place.  This commits moves
them all to the new docs/internals/ directory, and gives them 
a consistent naming scheme.




git-svn-id: svn://svn.valgrind.org/valgrind/trunk@4196
2005-07-19 21:46:19 +00:00
Nicholas Nethercote
d3a7dba217 Another todo item.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@3162
2004-11-30 14:10:13 +00:00
Nicholas Nethercote
ed7ce225ed Another todo item.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@3161
2004-11-30 14:09:22 +00:00
Nicholas Nethercote
4370a34af5 Updated todo list.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@3160
2004-11-30 14:08:24 +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