From: Nicholas Nethercote Date: Wed, 5 Aug 2009 07:39:45 +0000 (+0000) Subject: Various docs build tweaks: X-Git-Tag: svn/VALGRIND_3_5_0~130 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=3514eb673bff0518522a19e174e1d057e8080348;p=thirdparty%2Fvalgrind.git Various docs build tweaks: - Remove roadmap.txt, as we haven't used it for a while and Bugzilla does it better. - Inline docs/{internals,images,xml,lib}/Makefile.am into docs/Makefile.am, because they're very simple. Fewer Makefile.am files is good. - Remove the dead docs/images/massif*.png files and all references to them. git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10720 --- diff --git a/configure.in b/configure.in index 4407a37e9e..1a8627fda6 100644 --- a/configure.in +++ b/configure.in @@ -1842,10 +1842,6 @@ AC_CONFIG_FILES([ valgrind.pc glibc-2.X.supp docs/Makefile - docs/lib/Makefile - docs/images/Makefile - docs/internals/Makefile - docs/xml/Makefile tests/Makefile tests/vg_regtest perf/Makefile diff --git a/docs/Makefile.am b/docs/Makefile.am index 00d3e3a489..5759f0aae8 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -13,10 +13,61 @@ BUILD_ALL_DOCS=yes ## END OF HACK ##------------------------------------------------------------- - -SUBDIRS = xml lib images internals - -EXTRA_DIST = README +EXTRA_DIST = \ + README \ + images/home.png \ + images/next.png \ + images/prev.png \ + images/up.png \ + internals/3_0_BUGSTATUS.txt \ + internals/3_1_BUGSTATUS.txt \ + internals/3_2_BUGSTATUS.txt \ + internals/3_3_BUGSTATUS.txt \ + internals/3_4_BUGSTATUS.txt \ + internals/BIG_APP_NOTES.txt \ + internals/Darwin-notes.txt \ + internals/directory-structure.txt \ + internals/howto_BUILD_KDE42.txt \ + internals/howto_oprofile.txt \ + internals/m_replacemalloc.txt \ + internals/m_syswrap.txt \ + internals/module-structure.txt \ + internals/notes.txt \ + internals/porting-HOWTO.txt \ + internals/mpi2entries.txt \ + internals/porting-to-ARM.txt \ + internals/register-uses.txt \ + internals/release-HOWTO.txt \ + internals/segments-seginfos.txt \ + internals/threads-syscalls-signals.txt \ + internals/tm-mutexstates.dot \ + internals/tm-threadstates.dot \ + internals/tracking-fn-entry-exit.txt \ + internals/why-no-libc.txt \ + internals/xml-output.txt \ + internals/xml-output-protocol4.txt \ + lib/line-wrap.xsl \ + lib/vg_basic.css \ + lib/vg-fo.xsl \ + lib/vg-faq2txt.xsl \ + lib/vg-html-chunk.xsl \ + lib/vg-html-website.xsl \ + lib/vg-html-common.xsl \ + xml/FAQ.xml \ + xml/dist-docs.xml \ + xml/index.xml \ + xml/licenses.xml \ + xml/manual.xml \ + xml/manual-intro.xml \ + xml/manual-core.xml \ + xml/manual-core-adv.xml \ + xml/manual-writing-tools.xml \ + xml/design-impl.xml \ + xml/quick-start-guide.xml \ + xml/tech-docs.xml \ + xml/valgrind-manpage.xml \ + xml/vg-entities.xml \ + xml/xml_help.txt ##------------------------------------------------------------------- @@ -97,7 +148,6 @@ print-docs: export XML_CATALOG_FILES=$(XML_CATALOG_FILES) && \ mkdir -p $(myprintdir) && \ mkdir -p $(myprintdir)/images && \ - cp $(myimgdir)/massif-graph-sm.png $(myprintdir)/images && \ $(XSLTPROC) $(XSLTPROC_FLAGS) -o $(myprintdir)/index.fo $(XSL_FO_STYLE) $(myxmldir)/index.xml && \ (cd $(myprintdir) && \ ( pdfxmltex index.fo && \ @@ -204,7 +254,6 @@ download-docs: @echo "Generating valgrind_manual.pdf ..." mkdir -p $(vgdir)/print mkdir -p $(vgdir)/print/images - cp $(myimgdir)/massif-graph-sm.png $(vgdir)/print/images/ $(XSLTPROC) $(XSLTPROC_FLAGS) -o $(vgdir)/print/manual.fo $(XSL_FO_STYLE) $(myxmldir)/index.xml (cd $(vgdir)/print/ && \ ( pdfxmltex manual.fo && \ diff --git a/docs/images/Makefile.am b/docs/images/Makefile.am deleted file mode 100644 index c99caedeea..0000000000 --- a/docs/images/Makefile.am +++ /dev/null @@ -1,3 +0,0 @@ -EXTRA_DIST = \ - home.png next.png prev.png up.png \ - massif-graph-sm.png massif-graph.png diff --git a/docs/internals/Makefile.am b/docs/internals/Makefile.am deleted file mode 100644 index 0ccf00d75e..0000000000 --- a/docs/internals/Makefile.am +++ /dev/null @@ -1,20 +0,0 @@ -EXTRA_DIST = \ - 3_0_BUGSTATUS.txt 3_1_BUGSTATUS.txt \ - 3_2_BUGSTATUS.txt 3_3_BUGSTATUS.txt \ - 3_4_BUGSTATUS.txt \ - BIG_APP_NOTES.txt \ - Darwin-notes.txt \ - directory-structure.txt \ - howto_BUILD_KDE42.txt \ - howto_oprofile.txt \ - m_replacemalloc.txt \ - m_syswrap.txt module-structure.txt notes.txt porting-HOWTO.txt \ - mpi2entries.txt \ - porting-to-ARM.txt \ - register-uses.txt \ - release-HOWTO.txt roadmap.txt \ - segments-seginfos.txt threads-syscalls-signals.txt \ - tm-mutexstates.dot tm-threadstates.dot tracking-fn-entry-exit.txt \ - why-no-libc.txt \ - xml-output.txt \ - xml-output-protocol4.txt diff --git a/docs/internals/roadmap.txt b/docs/internals/roadmap.txt deleted file mode 100644 index c57eb1a500..0000000000 --- a/docs/internals/roadmap.txt +++ /dev/null @@ -1,143 +0,0 @@ -============================================================================= -Valgrind Roadmap -============================================================================= - -This file serves as a rough roadmap for Valgrind development. It shows a -minimal set of features we hope to implement for each version. It's in -reverse chronological order. - ------------------------------------------------------------------------------ -3.3.0 ------------------------------------------------------------------------------ -Scheduled for mid-to-late 2007? - -* Add ppc{32,64}/AIX5 support [Done by Julian] - -* Rework Massif [Done by Nick] - -* Rework Helgrind [Done by Julian] - -* Add experimental tools (Omega + DRD) [Julian] - ------------------------------------------------------------------------------ -3.2.4 ------------------------------------------------------------------------------ -Scheduled for mid-2007? - ------------------------------------------------------------------------------ -3.2.3 ------------------------------------------------------------------------------ -[Was released on Jan 29, 2007] - ------------------------------------------------------------------------------ -3.2.2 ------------------------------------------------------------------------------ -[Was released on Jan 22, 2007] - ------------------------------------------------------------------------------ -3.2.1 ------------------------------------------------------------------------------ -Scheduled for Dec 06? -[Was released on 16 Sep, 2006] - ------------------------------------------------------------------------------ -3.2.0 ------------------------------------------------------------------------------ -Scheduled for end-Mar 06 (3.1.0 + 4 months) ? -[Was released on Sep 16, 2006] - -In order of increasing speculativeness --------------------------------------- - -* Add ppc64-linux support. [Done by Julian] - -* Fold in the V bit compression stuff if it works well (early signs - are promising) and get rid of Addrcheck. - [Done by Nick. Average speedup of 1.20x, shadow memory size reduction of - 4.2x.] - -* Get function wrapping working again. [Done by Julian] - Reinstate basic thread checks. - Reinstate Helgrind. - -* Performance tuning: - - faster register allocation in vex - - improve stack-update pass [Done by Nick] - - assess effect of branch misprediction in dispatchers - -* Try to accelerate development for Darwin ? - -Smaller things --------------- -* Consider using the following defaults: - --leak-check=yes - --num-callers=20 - -* Expose some of m_redir's functionality to tools so that Memcheck - can replace strlen/strcmp on PPC32 (remove the 3.1.0 hack for this - which checked in m_redir.c if the current tool was Memcheck). - [Won't bother. The fix is worse than the problem it's trying to solve; - the issue is that the replacement functions are in m_trampoline.S and must - be between VG_(trampoline_stuff_start) and VG_(trampoline_stuff_end) for - arcane reasons and moving them into a tool-visible place is a pain.] - ------------------------------------------------------------------------------ -3.1.1 ------------------------------------------------------------------------------ -Tentatively end-Dec 05 (3.1.0 + 1 month): fix any critical bugs in -3.1.0. -[Was released on Mar 16, 2006] - ------------------------------------------------------------------------------ -3.1.0 ------------------------------------------------------------------------------ -Scheduled for around November 2005. (Released 27 Nov 05). - -Definite --------- -* Get 32-bit and 64-bit programs working smoothly on AMD64 (Tom?). Several - levels of smoothness here, we should aim for at least level 3. - - 1. Be able to build a 32-bit valgrind on a 64-bit machine, so you can - build and install both, and manually choose between bin/valgrind and - bin64/valgrind. - 2. Build both automatically when installing. - 3. Choose the appropriate executable automatically at startup just from - "valgrind". - 4. With --trace-children=yes, allow 32-bit programs to exec 64-bit - programs and vice versa, and invoke the appropriate Valgrind - automatically. - [All four levels done by Tom] - -* Get PPC32 working usably with Memcheck (Julian). Has already improved a - lot since. Get Cachegrind working with it (Nick). - [Both done by Julian] - -* Rewrite address space manager; statically link the core with - each tool; remove all glibc dependencies (Julian). - [Done by Julian] - -* What about --time-stamp=yes? - [Fixed by Julian to give relative time since startup] - -* Make it work with GCC 2.95 (bug #111781) -- don't put declarations after - statements in blocks. Do it after merging ASPACEM with the trunk. - -Wdeclaration-after-statement is the GCC warning that detects this, but - it is only present in GCC after 3.4.0 (ie. not in 3.0.X--3.3.X)... - [Done by Tom and others] - -* We need to reintroduce some kind of core/tool interface versioning, - so that if external tools link with libcoregrind.a incompatibilities - are detected. - -Maybe ------ -* Get pthread modelling and Helgrind working again. Requires function - wrapping (Nick). - [Won't happen for 3.1.0. Function wrapping is difficult.] - -* Reinstate Addrcheck and/or implement V-bit compression in Memcheck (?). - [Won't happen for 3.1.0.] - -* Allow suppressions by filename + line number? (Joseph Link's patch) - diff --git a/docs/lib/Makefile.am b/docs/lib/Makefile.am deleted file mode 100644 index dc794d2b54..0000000000 --- a/docs/lib/Makefile.am +++ /dev/null @@ -1,8 +0,0 @@ -EXTRA_DIST = \ - vg_basic.css \ - vg-fo.xsl \ - vg-faq2txt.xsl \ - line-wrap.xsl \ - vg-html-chunk.xsl \ - vg-html-website.xsl \ - vg-html-common.xsl diff --git a/docs/xml/Makefile.am b/docs/xml/Makefile.am deleted file mode 100644 index 9201905160..0000000000 --- a/docs/xml/Makefile.am +++ /dev/null @@ -1,16 +0,0 @@ -EXTRA_DIST = \ - FAQ.xml \ - dist-docs.xml \ - index.xml \ - licenses.xml \ - manual.xml \ - manual-intro.xml \ - manual-core.xml \ - manual-core-adv.xml \ - manual-writing-tools.xml\ - design-impl.xml \ - quick-start-guide.xml \ - tech-docs.xml \ - valgrind-manpage.xml \ - vg-entities.xml \ - xml_help.txt