From: Donna Robinson Date: Fri, 25 Nov 2005 05:36:48 +0000 (+0000) Subject: Due to package upgrades (docbook, passivetex), removed some X-Git-Tag: svn/VALGRIND_3_1_0~3 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2022dbf52c89a9b039cdda5b76f89293b8c9faa9;p=thirdparty%2Fvalgrind.git Due to package upgrades (docbook, passivetex), removed some bug-patches and created some new ones in the stylesheets. Also tweaked some files to structure the xml properly. The FAQ and the Quick-Start are now 'articles' inside a book-wrapper, which is as it should be. FAQ.xml - due to various passivetex bug fixes, the faq is now a properly structured xml qandaset document quick-start-guide.xml: manual.xml - Fixed some passivetex-workaround kludges: legalnotice -> author manual-core.xml: For readability, added '' to varlistentry items since passivetex (sigh) will no longer indent the para text. index.xml: - loads of white-space readability tweaks here and there. tech-docs.xml dist-docs.xml manual.xml - additional entries to for compatability with the rest of the docs. /docs/Makefile.am - added stuff to use the new vg-faq2txt.xsl stylesheet /docs/lib/Makefile.am - updated to reflect current contents of /docs/lib/ - removed refs to vg-html-single as is never ever used /docs/lib/vg-fo.xsl - massively updated to reflect losing old bugs and gaining new ones /docs/lib/vg-common.xsl - deleted as only contained two lines common to html and fo, so not worth the bother of hauling around /docs/lib/vg-html-chunk.xsl - added what was in vg-common.xsl /docs/lib/line-wrap.xsl /docs/lib/faq2text.xsl - two new stylesheet files for transforming FAQ.xml to FAQ.txt git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5234 --- diff --git a/docs/Makefile.am b/docs/Makefile.am index 87bd4e2912..f9608d4430 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -48,8 +48,8 @@ XSLTPROC_FLAGS = --nonet --xinclude # stylesheets XSL_HTML_CHUNK_STYLE = $(mylibdir)/vg-html-chunk.xsl -XSL_HTML_SINGLE_STYLE = $(mylibdir)/vg-html-single.xsl XSL_FO_STYLE = $(mylibdir)/vg-fo.xsl +XSL_TEXT_STYLE = $(mylibdir)/vg-faq2txt.xsl all-docs: FAQ.txt html-docs print-docs @@ -57,12 +57,12 @@ valid: $(XMLLINT) $(XMLLINT_FLAGS) $(myxmldir)/index.xml # The text version of the FAQ. -FAQ.txt: $(myxmldir)/FAQ.xml $(myxmldir)/vg-entities.xml $(mylibdir)/*.xslt - $(XSLTPROC) $(XSLTPROC_FLAGS) $(mylibdir)/untag-inline.xslt $(myxmldir)/FAQ.xml | \ - $(XSLTPROC) $(XSLTPROC_FLAGS) $(mylibdir)/docbook2text.xslt - > FAQ.txt - +FAQ.txt: + @echo "Generating the text version of the FAQ ..." + export XML_CATALOG_FILES=$(XML_CATALOG_FILES) && \ + $(XSLTPROC) $(XSLTPROC_FLAGS) -o ./FAQ.txt $(XSL_TEXT_STYLE) $(myxmldir)/FAQ.xml -# chunked html +# chunked html, on a chapter-by-chapter basis html-docs: @echo "Generating html files..." export XML_CATALOG_FILES=$(XML_CATALOG_FILES) && \ diff --git a/docs/lib/Makefile.am b/docs/lib/Makefile.am index c589900a28..44acd8f19f 100644 --- a/docs/lib/Makefile.am +++ b/docs/lib/Makefile.am @@ -1,16 +1,6 @@ -EXTRA_DIST = \ - README_XML2TXT.txt \ - copy.xslt \ - text.justify.xslt \ - docbook2text.xslt \ - text.wrap.xslt \ - str.dup.xslt \ - untag-inline.xslt \ - str.find-last.xslt \ - vg-common.xsl \ - vg-fo.xsl \ +EXTRA_DIST = \ + vg-fo.xsl \ vg-html-chunk.xsl \ - vg-html-single.xsl \ + vg-faq2txt.xsl \ + line-wrap.xsl \ vg_basic.css - - diff --git a/docs/lib/README_XML2TXT.txt b/docs/lib/README_XML2TXT.txt deleted file mode 100644 index 3d70becfab..0000000000 --- a/docs/lib/README_XML2TXT.txt +++ /dev/null @@ -1,59 +0,0 @@ -README.txt file for the FAQ.xml to FAQ.txt transformer. -======================================================= - -In valgrind-3.1.SVN, file docs/README contains, under the heading -"TODO CRUCIAL", the item "Need to generate text FAQ from the -valgrind/docs/xml/FAQ.xml (done at 'make dist' time along with the -HTML docs using the 'dist-hook'), and remove the old text FAQ which is -in valgrind/." This is an attempt to resolve this item using xsltproc -and a number of xml style sheets. It is a hack in the sense that it -does not support all of docbook, but only the subset currently used by -file docs/xml/FAQ.xml. - -The transformation is done in two stages: - -1. Inline elements (literal, computeroutput and ulink) are replaced - with the corresponding text by stylesheet untag-inline.xslt. This - stylesheet uses copy.xslt to handle the non-inline elements. - -2. The actual formatting is done by stylesheet docbook2text.xslt. It - uses stylesheets str.dup.xslt, str.find-last.xslt, - text.justify.xslt and text.wrap.xslt to handle the formatting of - the text into a column with the approproate width and indentation. - -Stylesheets untag-inline.xslt and docbook2text.xslt are original -work. Stylesheets copy.xslt, str.dup.xslt, str.find-last.xslt, -text.justify.xslt and text.wrap.xslt are copied with some adaptations -from the examples supplied with the XSLT Cookbook by Sal Mangano, (C) -2003 O'Reilly & Associates, ISBN 0-596-00372-2. The O'Reilly Policy on -Re-Use of Code Examples from Books - -allows the use of these style sheets in valgrind for this purpose. - -The tarball contains: - -- File README.txt (this file). - -- the stylesheets copy.xslt, docbook2text.xslt, str.dup.xslt, - str.find-last.xslt, text.justify.xslt, text.wrap.xslt and - untag-inline.xslt. - -- File faq.txt.patch adds the generation of FAQ.txt to file - docs/Makefile.am. It is based on the assumptions that - * file FAQ.txt will be generated in directory docs. - * the stylesheets will be stored in directory docs/lib. - If a different output width is required (e.g. 80), you can use - command - $(XSLTPROC) $(XSLTPROC_FLAGS) $(libdir)/untag-inline.xslt $(xmldir)/FAQ.xml | \ - $(XSLTPROC) $(XSLTPROC_FLAGS) --stringparam width 80 $(libdir)/docbook2text.xslt - > FAQ.txt - -- File FAQ.txt as generated on my system (Debian 3.1). - -Software used: -xsltproc was compiled against libxml 20616, libxslt 10112 and libexslt 810 -libxslt 10112 was compiled against libxml 20616 -libexslt 810 was compiled against libxml 20616 - - -Copyright 2005 Jeroen N. Witmond, jnw@xs4all.nl -GNU GENERAL PUBLIC LICENSE Version 2, June 1991 applies. diff --git a/docs/lib/copy.xslt b/docs/lib/copy.xslt deleted file mode 100644 index b2c565d3f5..0000000000 --- a/docs/lib/copy.xslt +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - - - - - - - - - diff --git a/docs/lib/docbook2text.xslt b/docs/lib/docbook2text.xslt deleted file mode 100644 index becc8620da..0000000000 --- a/docs/lib/docbook2text.xslt +++ /dev/null @@ -1,317 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Table of Contents - - - - - - - - - - . - - - - - - - - - - - - - - . - - - - - - - - - - - - - - - - - - - - - - - - - template match="sect1": Encountered - <>. - - - - - - - - - - - - - - - - - - - - - - . - - . - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - template match="para": Encountered - <>. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - . - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/lib/line-wrap.xsl b/docs/lib/line-wrap.xsl new file mode 100644 index 0000000000..1405ceb81b --- /dev/null +++ b/docs/lib/line-wrap.xsl @@ -0,0 +1,131 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/lib/str.dup.xslt b/docs/lib/str.dup.xslt deleted file mode 100644 index 564b3422ef..0000000000 --- a/docs/lib/str.dup.xslt +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/lib/str.find-last.xslt b/docs/lib/str.find-last.xslt deleted file mode 100644 index 2700fd3495..0000000000 --- a/docs/lib/str.find-last.xslt +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/lib/text.justify.xslt b/docs/lib/text.justify.xslt deleted file mode 100644 index a6a8992ce6..0000000000 --- a/docs/lib/text.justify.xslt +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - INVALID ALIGN - - - - diff --git a/docs/lib/text.wrap.xslt b/docs/lib/text.wrap.xslt deleted file mode 100644 index e77819e133..0000000000 --- a/docs/lib/text.wrap.xslt +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/lib/untag-inline.xslt b/docs/lib/untag-inline.xslt deleted file mode 100644 index ea553a5cb8..0000000000 --- a/docs/lib/untag-inline.xslt +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - '' - - <> - - - diff --git a/docs/lib/vg-common.xsl b/docs/lib/vg-common.xsl deleted file mode 100644 index 7d4aebe820..0000000000 --- a/docs/lib/vg-common.xsl +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - - - - - - - - - - - - -set toc,title -book toc,title,figure,table,example,equation -chapter toc,title -section toc -sect1 toc -sect2 toc -sect3 toc -sect4 nop -sect5 nop -qandaset toc -qandadiv nop -appendix toc,title -article/appendix nop - -article nop -preface toc,title -reference toc,title - - - - - center - - - - - - - - - diff --git a/docs/lib/vg-faq2txt.xsl b/docs/lib/vg-faq2txt.xsl new file mode 100644 index 0000000000..97431bb604 --- /dev/null +++ b/docs/lib/vg-faq2txt.xsl @@ -0,0 +1,330 @@ + + + + + + +]> + + + + + + + + + + + + + + +book nop +article nop +qandaset toc +qandadiv nop + + + + + + &nl; + + + + + + + + + + + + &nl; + + + + + + + + + + + + + &nl; + + + + + &nl; + + + + + + + &nl; + + + + + + + + + + + + + + + + + + + + + + + + + Table of Contents + + + &nl; + + + + + + + + + + &nl;&rule;&nl; + + . + + &nl;&rule;&nl;&nl; + + + + + + + + + + + + + + + + + &nl; + + . + + + + + + + + + + + + + + &rule;&nl;&nl; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + &nl; + + + + + + + + + &nl; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + < + + + + + + + + + > + + + + + + + + + + + + + &nl; + + &indent; + + + + + + + &indent; + + &nl; + + + + + + + + + + + + + + + &nl; + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/lib/vg-fo.xsl b/docs/lib/vg-fo.xsl index bf852de719..ae4af84fe3 100644 --- a/docs/lib/vg-fo.xsl +++ b/docs/lib/vg-fo.xsl @@ -3,42 +3,63 @@ xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> - - - - + + - - - - - - + + + + + + + + + +set toc,title +book toc,title +part toc,title +chapter nop,title +section nop +sect1 nop +sect2 nop +sect3 nop +sect4 nop +sect5 nop +article nop +book/article nop +article/sect1 nop +appendix toc,title +preface toc,title +reference toc,title +qandadiv toc +qandaset toc + - - + + + + + + + + + + + + + - - - - - - - - blue - - + - always + always @@ -53,212 +74,284 @@ false - - - - - + + + + + - - - - - - - - - - - - - - • - • - • - - - - - - + + + blue + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + - - - - - - + + + + + + + + + + + - + - - - - - - - - - - - - - - - - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Email: + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + - - - + - - - + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - 0pt - - - - - - - - baseline - - - - - - baseline - - - - - - - - - - - + + + + + + + + + + + + + + + - - - - - - + + @@ -267,73 +360,65 @@ - - - - - + + + + + + + + + + + + + + + + + + + - - 0pt + + + + + + + + + - - - - - - - - - - - - - baseline - - - - - - baseline - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - + + + + - + + + - - diff --git a/docs/lib/vg-html-chunk.xsl b/docs/lib/vg-html-chunk.xsl index 137d5ba9e3..f9e943f102 100644 --- a/docs/lib/vg-html-chunk.xsl +++ b/docs/lib/vg-html-chunk.xsl @@ -1,22 +1,70 @@ - + - + + + + +set toc,title +book toc,title,figure,table,example,equation +chapter toc,title +section toc +sect1 toc +sect2 toc +sect3 toc +sect4 nop +sect5 nop +qandaset toc +qandadiv toc +appendix toc,title +article/appendix nop +article nop +preface toc,title +reference toc,title + + + + + + + + + + + + + + + + + + + + + + + + + + + + center + + diff --git a/docs/lib/vg-html-single.xsl b/docs/lib/vg-html-single.xsl deleted file mode 100644 index c6c1cec94a..0000000000 --- a/docs/lib/vg-html-single.xsl +++ /dev/null @@ -1,63 +0,0 @@ - - ]> - - - - - - - - - - - - - - - - - - - 3 - 2 - - - - - - - - - -
-

Revision History

-
- - - - - - - - - - - - - - - -   - - - - -   - - - - diff --git a/docs/xml/FAQ.xml b/docs/xml/FAQ.xml index 6ab229f2ec..dd486a683e 100644 --- a/docs/xml/FAQ.xml +++ b/docs/xml/FAQ.xml @@ -7,28 +7,34 @@ Valgrind FAQ - Valgrind Frequently Asked Questions &rel-type; &rel-version; &rel-date; - - &vg-lifespan; - Valgrind Developers - - - Email: &vg-vemail; - + + &vg-lifespan; + Valgrind Developers + + + &vg-vemail; + - -Background +
+Valgrind Frequently Asked Questions + + + + - + + + +Background - + How do you pronounce "Valgrind"? - + The "Val" as in the world "value". The "grind" is pronounced with a short 'i' -- ie. "grinned" (rhymes with "tinned") rather than "grined" (rhymes with "find"). @@ -38,10 +44,10 @@ - + Where does the name "Valgrind" come from? - + From Nordic mythology. Originally (before release) the project was named Heimdall, after the watchman of the Nordic gods. He could "see a hundred miles by day or night, hear the @@ -60,27 +66,24 @@ - + - - + + Compiling, installing and configuring - - + When I trying building Valgrind, 'make' dies partway with - an assertion failure, something like this: + an assertion failure, something like this: % make: expand.c:489: allocated_variable_append: Assertion 'current_variable_set_list->next != 0' failed. - - + It's probably a bug in 'make'. Some, but not all, instances of version 3.79.1 have this bug, see www.mail-archive.com/bug-make@gnu.org/msg01658.html. Try @@ -90,48 +93,43 @@ - - + - + + Valgrind aborts unexpectedly - - + Programs run OK on Valgrind, but at exit produce a bunch of errors involving __libc_freeres() and then die with a segmentation fault. - - When the program exits, Valgrind runs the procedure - __libc_freeres() in glibc. This is a hook - for memory debuggers, so they can ask glibc to free up any - memory it has used. Doing that is needed to ensure that - Valgrind doesn't incorrectly report space leaks in glibc. - Problem is that running - __libc_freeres() in older glibc versions - causes this crash. WORKAROUND FOR 1.1.X and later - versions of Valgrind: use the - --run-libc-freeres=no flag. You may then get - space leak reports for glibc-allocations (please _don't_ report - these to the glibc people, since they are not real leaks), but - at least the program runs. + + When the program exits, Valgrind runs the procedure + __libc_freeres() in glibc. This is a hook + for memory debuggers, so they can ask glibc to free up any + memory it has used. Doing that is needed to ensure that + Valgrind doesn't incorrectly report space leaks in glibc. + Problem is that running + __libc_freeres() in older glibc versions + causes this crash. WORKAROUND FOR 1.1.X and later + versions of Valgrind: use the + --run-libc-freeres=no flag. You may then get + space leak reports for glibc-allocations (please _don't_ report + these to the glibc people, since they are not real leaks), but + at least the program runs. - + My (buggy) program dies like this: - -% valgrind: vg_malloc2.c:442 (bszW_to_pszW): Assertion 'pszW >= 0' failed. - - +% valgrind: vg_malloc2.c:442 (bszW_to_pszW): Assertion 'pszW >= 0' failed. - + If Memcheck (the memory checker) shows any invalid reads, invalid writes and invalid frees in your program, the above may happen. Reason is that your program may trash Valgrind's @@ -143,15 +141,12 @@ - + My program dies, printing a message like this along the way: - -% disInstr: unhandled instruction bytes: 0x66 0xF 0x2E 0x5 - - +% disInstr: unhandled instruction bytes: 0x66 0xF 0x2E 0x5 - + Older versions did not support some x86 instructions, particularly SSE/SSE2 instructions. Try a newer Valgrind; we now support almost all instructions. If it still happens with @@ -170,54 +165,51 @@ - + I tried running a Java program (or another program that uses a - just-in-time compiler) under Valgrind but something went wrong. - Does Valgrind handle such programs? - + just-in-time compiler) under Valgrind but something went wrong. + Does Valgrind handle such programs? - + Valgrind can handle dynamically generated code, so long as none - of the generated code is later overwritten by other generated code. - If this happens, though, things will go wrong as Valgrind will continue - running its translations of the old code (this is true on x86 and AMD64, - on PPC32 there are explicit cache flush instructions which Valgrind - detects). You should try running with - --smc-check=all in this case; Valgrind - will run much more slowly, but should detect the use of the out-of-date - code. + of the generated code is later overwritten by other generated code. + If this happens, though, things will go wrong as Valgrind will continue + running its translations of the old code (this is true on x86 and AMD64, + on PPC32 there are explicit cache flush instructions which Valgrind + detects). You should try running with + --smc-check=all in this case; Valgrind + will run much more slowly, but should detect the use of the out-of-date + code. Alternativaly, if you have the source code to the JIT compiler you - can insert calls to the - VALGRIND_DISCARD_TRANSLATIONS client - request to mark out-of-date code, saving you from using - --smc-check=all. + can insert calls to the + VALGRIND_DISCARD_TRANSLATIONS client + request to mark out-of-date code, saving you from using + --smc-check=all. Apart from this, in theory Valgrind can run any Java program just - fine, even those that use JNI and are partially implemented in other - languages like C and C++. In practice, Java implementations tend to do - nasty things that most programs do not, and Valgrind sometimes falls - over these corner cases. + fine, even those that use JNI and are partially implemented in other + languages like C and C++. In practice, Java implementations tend to do + nasty things that most programs do not, and Valgrind sometimes falls + over these corner cases. If your Java programs do not run under Valgrind, even with - --smc-check=all, please file a bug - report and hopefully we'll be able to fix the problem. + --smc-check=all, please file a bug + report and hopefully we'll be able to fix the problem. - - + - + + Valgrind behaves unexpectedly - - + My program uses the C++ STL and string classes. Valgrind reports 'still reachable' memory leaks involving these classes at the exit of the program, but there should be none. - + First of all: relax, it's probably not a bug, but a feature. Many implementations of the C++ standard libraries use their own memory pool allocators. Memory for quite a @@ -276,11 +268,11 @@ - + The stack traces given by Memcheck (or another tool) aren't helpful. How can I improve them? - + If they're not long enough, use --num-callers to make them longer. If they're not detailed enough, make sure you are @@ -359,36 +351,35 @@ Invalid write of size 1 - + The stack traces given by Memcheck (or another tool) seem to have the wrong function name in them. What's happening? - + Occasionally Valgrind stack traces get the wrong function names. This is caused by glibc using aliases to effectively give one function two names. Most of the time Valgrind chooses a suitable name, but very occasionally it gets it wrong. - Examples we know of are printing 'bcmp' instead of 'memcmp', 'index' instead of 'strchr', and 'rindex' instead of 'strrchr'. - - + + - + + Memcheck doesn't find my bug - - + I try running "valgrind --tool=memcheck my_program" and get Valgrind's startup message, but I don't get any errors and I know my program has errors. - + There are two possible causes of this. First, by default, Valgrind only traces the top-level process. @@ -428,7 +419,7 @@ statically linking your program. - + Why doesn't Memcheck find the array overruns in this program? int static[5]; @@ -444,7 +435,7 @@ int main(void) } - + Unfortunately, Memcheck doesn't do bounds checking on static or stack arrays. We'd like to, but it's just not possible to do in a reasonable way that fits with how Memcheck @@ -452,22 +443,20 @@ int main(void) + - - - + + Miscellaneous - - + I tried writing a suppression but it didn't work. Can you write my suppression for me? - + Yes! Use the --gen-suppressions=yes feature to spit out suppressions automatically for you. You can then @@ -483,12 +472,12 @@ int main(void) - + With Memcheck/Addrcheck's memory leak detector, what's the difference between "definitely lost", "possibly lost", "still reachable", and "suppressed"? - + The details are in the Memcheck section of the user manual. In short: @@ -515,79 +504,85 @@ int main(void) suppression files. You can ignore suppressed errors. - + + - - - + +How To Get Further Assistance - - - - - - - - + - - ---> + + Please read all of this section before posting. + If you think an answer is incomplete or inaccurate, please + e-mail &vg-vemail;. + Read the appropriate section(s) of the + Valgrind + Documentation. - -How To Get Further Assistance + Read the Distribution Documents. + Search the + valgrind-users mailing list archives, using the group name + gmane.comp.debugging.valgrind. -Please read all of this section before posting. + Only when you have tried all of these things and are still stuck, + should you post to the valgrind-users + mailing list. In which case, please read the following + carefully. Making a complete posting will greatly increase the chances + that an expert or fellow user reading it will have enough information + and motivation to reply. -If you think an answer is incomplete or inaccurate, please -e-mail &vg-vemail;. + Make sure you give full details of the problem, + including the full output of valgrind -v, + if applicable. Also which Linux distribution you're using (Red Hat, Debian, etc) + and its version number. -Read the appropriate section(s) of the Manual(s): -Valgrind -Documentation. + You are in little danger of making your posting too long + unless you include large chunks of valgrind's (unsuppressed) + output, so err on the side of giving too much information. -Read the Distribution Documents. + Clearly written subject lines and message bodies are appreciated, + too. -Search the -valgrind-users mailing list archives, using the group name -gmane.comp.debugging.valgrind. + Finally, remember that, despite the fact that most of the + community are very helpful and responsive to emailed questions, + you are probably requesting help from unpaid volunteers, so you + have no guarantee of receiving an answer. + -Only when you have tried all of these things and are still stuck, -should you post to the valgrind-users -mailing list. In which case, please read the following -carefully. Making a complete posting will greatly increase the chances -that an expert or fellow user reading it will have enough information -and motivation to reply. + + -Make sure you give full details of the problem, -including the full output of valgrind --v, if applicable. Also which Linux distribution -you're using (Red Hat, Debian, etc) and its version number. -You are in little danger of making your posting too long -unless you include large chunks of valgrind's (unsuppressed) -output, so err on the side of giving too much information. + + + -Clearly written subject lines and message bodies are appreciated, -too. -Finally, remember that, despite the fact that most of the -community are very helpful and responsive to emailed questions, -you are probably requesting help from unpaid volunteers, so you -have no guarantee of receiving an answer. + +
diff --git a/docs/xml/dist-docs.xml b/docs/xml/dist-docs.xml index 3588349faf..3e99c39d85 100644 --- a/docs/xml/dist-docs.xml +++ b/docs/xml/dist-docs.xml @@ -1,11 +1,20 @@ + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[ %vg-entities; ]> - Distribution Documents + Valgrind Distribution Documents + &rel-type; &rel-version; &rel-date; + + &vg-lifespan; + Valgrind Developers + + + &vg-vemail; + + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[ %vg-entities; ]> Valgrind Technical Documentation + &rel-type; &rel-version; &rel-date; + + &vg-lifespan; + Valgrind Developers + + + &vg-vemail; +