|
From: <sv...@va...> - 2007-05-18 10:49:14
|
Author: sewardj
Date: 2007-05-18 11:49:12 +0100 (Fri, 18 May 2007)
New Revision: 6743
Log:
Edit the manual to bring it up to date and make some of the wording a
bit more professional sounding. I believe its last major overhaul was
around 3.1.0 time, and some of the text dates from 2002, when V was
more of a fun hack and not a widely used tool, so some of the "relaxed
terminology" :-) is less appropriate now. The main changes are:
* lots of minor wording adjustments to:
- bring facts up to date
- remove very informal styles of writing
- we have many run-on sentences (sentence 1; sentence 2) which
I split into two (sentence 1. Sentence 2). Similarly, we
overuse sub-sentences in parentheses, some of which I have
turned into fully fledged sentences.
- make naming more consistent: change "valgrind" to "Valgrind"
or to the current tool name, as appropriate
* delete Helgrind section from the manual (not by really deleting
it, but commenting out the relevant include-file statement).
I don't think it's good to have the manual describing functionality
that the code doesn't provide.
* various rewordings in the Callgrind manual
* add missing flag docs to Lackey manual
Modified:
branches/VALGRIND_3_2_BRANCH/cachegrind/docs/cg-manual.xml
branches/VALGRIND_3_2_BRANCH/callgrind/docs/cl-manual.xml
branches/VALGRIND_3_2_BRANCH/docs/xml/FAQ.xml
branches/VALGRIND_3_2_BRANCH/docs/xml/manual-core.xml
branches/VALGRIND_3_2_BRANCH/docs/xml/manual-intro.xml
branches/VALGRIND_3_2_BRANCH/docs/xml/manual.xml
branches/VALGRIND_3_2_BRANCH/docs/xml/quick-start-guide.xml
branches/VALGRIND_3_2_BRANCH/lackey/docs/lk-manual.xml
branches/VALGRIND_3_2_BRANCH/massif/docs/ms-manual.xml
branches/VALGRIND_3_2_BRANCH/memcheck/docs/mc-manual.xml
[... diff too large to include ...]
|