jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add ccache documentation to main docs

Browse source 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@10990 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
William S Fulton 2008-12-20 01:45:11 +00:00
commit f8d3c2400d
5 changed files with 50 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

1
CCache/Makefile.in
View file

@ -27,6 +27,7 @@ HEADERS = ccache.h mdfour.h
all: $(PACKAGE_NAME)$(EXEEXT) all: $(PACKAGE_NAME)$(EXEEXT)
# Note that HTML documentation is actually generated and used from the main SWIG documentation Makefile
docs: $(PACKAGE_NAME).1 web/ccache-man.html docs: $(PACKAGE_NAME).1 web/ccache-man.html
$(PACKAGE_NAME)$(EXEEXT): $(OBJS) $(HEADERS) $(PACKAGE_NAME)$(EXEEXT): $(OBJS) $(HEADERS)

35
CCache/ccache.yo
View file

@ -1,6 +1,32 @@
mailto(swig-devel see: http://www.swig.org/mail.html) whenman(
COMMENT(html output not great if included when using html2doc)
manpage(ccache-swig)(1)()()() manpage(ccache-swig)(1)()()()
)
whenhtml(htmlcommand(
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>swig-ccache(1) manpage</title>
<link rel="stylesheet" type="text/css" href="style.css">
</head>
<body bgcolor="#ffffff">
<H1><a name="CCache"></a>swig-ccache(1) manpage</H1>
<!-- INDEX -->
<div class="sectiontoc">
<!-- INDEX -->
))
manpagename(ccache-swig)(a fast compiler cache) manpagename(ccache-swig)(a fast compiler cache)
whenhtml(htmlcommand(
ccache-swig - a fast compiler cache
))
manpagesynopsis() manpagesynopsis()
ccache-swig [OPTION] ccache-swig [OPTION]
@ -380,3 +406,10 @@ url(http://www.swig.org/mail.html)(http://www.swig.org/mail.html)
ccache is released under the GNU General Public License version 2 or ccache is released under the GNU General Public License version 2 or
later. Please see the file COPYING for license details. later. Please see the file COPYING for license details.
whenhtml(htmlcommand(
</body>
</html>
))

7
CHANGES.current
View file

@ -1,6 +1,13 @@
Version 1.3.37 (in progress) Version 1.3.37 (in progress)
============================ ============================
2008-12-20: wsfulton
The ccache compiler cache has been adapted to work with SWIG and
named ccache-swig. It now works with C/C++ compilers as well as SWIG
and can result in impressive speedups when used to recompile unchanged
code with either a C/C++ compiler or SWIG. Documentation is in CCache.html
or the installed ccache-swig man page.
2008-12-12: wsfulton 2008-12-12: wsfulton
Apply patch from Kalyanov Dmitry which fixes parsing of nested structs Apply patch from Kalyanov Dmitry which fixes parsing of nested structs
containing comments. containing comments.

9
Doc/Manual/Makefile
View file

@ -18,15 +18,19 @@ HTMLDOC_OPTIONS = "--book --toclevels 4 --no-numbered --toctitle \"Table of Cont
all: maketoc check generate all: maketoc check generate
maketoc: maketoc: CCache.html
python maketoc.py python maketoc.py
CCache.html: ../../CCache/ccache.yo
yodl2html -o CCache.html ../../CCache/ccache.yo
# Use htmltidy to warn about some HTML errors. Note that it is not used to clean/tidy the HTML, # Use htmltidy to warn about some HTML errors. Note that it is not used to clean/tidy the HTML,
# it is just used as a primitive HTML checker. # it is just used as a primitive HTML checker.
# CCache.html is generated by yodl2html and has a few insignificant problems, so we don't put it through tidy
check: check:
tidy -errors --gnu-emacs yes -quiet index.html tidy -errors --gnu-emacs yes -quiet index.html
tidy -errors --gnu-emacs yes -quiet Sections.html tidy -errors --gnu-emacs yes -quiet Sections.html
all=`sed '/^#/d' chapters`; for a in $$all; do tidy -errors --gnu-emacs yes -quiet $$a; done; all=`sed '/^#/d' chapters | grep -v CCache.html`; for a in $$all; do tidy -errors --gnu-emacs yes -quiet $$a; done;
generate: swightml.book swigpdf.book generate: swightml.book swigpdf.book
htmldoc --batch swightml.book || true htmldoc --batch swightml.book || true
@ -48,6 +52,7 @@ swightml.book:
clean: clean-baks clean: clean-baks
rm -f swightml.book rm -f swightml.book
rm -f swigpdf.book rm -f swigpdf.book
rm -f CCache.html
rm -f SWIGDocumentation.html rm -f SWIGDocumentation.html
rm -f SWIGDocumentation.pdf rm -f SWIGDocumentation.pdf

2
Tools/mkdist.py
View file

@ -57,7 +57,7 @@ os.system("find "+dirname+" -name autom4te.cache -exec rm -rf {} \\;")
# Build documentation # Build documentation
print "Building documentation" print "Building documentation"
os.system("cd "+dirname+"/Doc/Manual && make all clean-baks") == 0 or failed() os.system("cd "+dirname+"/Doc/Manual && make all clean-baks") == 0 or failed()
os.system("cd "+dirname+"/CCache && yodl2man -o swig-ccache.1 ccache.yo && mkdir -p man && yodl2html -o web/ccache-man.html ccache.yo") == 0 or failed() os.system("cd "+dirname+"/CCache && yodl2man -o swig-ccache.1 ccache.yo") == 0 or failed()
# Build the tar-ball # Build the tar-ball
os.system("tar -cf "+dirname+".tar "+dirname) == 0 or failed() os.system("tar -cf "+dirname+".tar "+dirname) == 0 or failed()