diff options
Diffstat (limited to 'lib/syntax_tools/doc/src')
| -rw-r--r-- | lib/syntax_tools/doc/src/Makefile | 137 | ||||
| -rw-r--r-- | lib/syntax_tools/doc/src/book.xml | 48 | ||||
| -rw-r--r-- | lib/syntax_tools/doc/src/fascicules.xml | 18 | ||||
| -rw-r--r-- | lib/syntax_tools/doc/src/make.dep | 22 | ||||
| -rw-r--r-- | lib/syntax_tools/doc/src/notes.xml | 176 | ||||
| -rw-r--r-- | lib/syntax_tools/doc/src/part.xml | 41 | ||||
| -rw-r--r-- | lib/syntax_tools/doc/src/part_notes.xml | 41 | ||||
| -rw-r--r-- | lib/syntax_tools/doc/src/ref_man.xml | 49 |
8 files changed, 532 insertions, 0 deletions
diff --git a/lib/syntax_tools/doc/src/Makefile b/lib/syntax_tools/doc/src/Makefile new file mode 100644 index 0000000000..2065614251 --- /dev/null +++ b/lib/syntax_tools/doc/src/Makefile @@ -0,0 +1,137 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2006-2009. All Rights Reserved. +# +# The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved online at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# %CopyrightEnd% +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include ../../vsn.mk +VSN=$(SYNTAX_TOOLS_VSN) +APPLICATION=syntax_tools + +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN) + +# ---------------------------------------------------- +# Man page source directory (with .erl files) +# ---------------------------------------------------- +SRC_DIR = $(ERL_TOP)/lib/syntax_tools/src +INC_DIR = $(ERL_TOP)/lib/syntax_tools/include + +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- +XML_APPLICATION_FILES = ref_man.xml +XML_REF3_FILES = \ + epp_dodger.xml \ + erl_comment_scan.xml \ + erl_prettypr.xml \ + erl_recomment.xml \ + erl_syntax.xml \ + erl_syntax_lib.xml \ + erl_tidy.xml \ + igor.xml \ + prettypr.xml + +XML_PART_FILES = part.xml part_notes.xml +XML_CHAPTER_FILES = chapter.xml +XML_NOTES_FILES = notes.xml + +BOOK_FILES = book.xml + + +XML_FILES=\ + $(BOOK_FILES) $(XML_CHAPTER_FILES) \ + $(XML_PART_FILES) $(XML_REF3_FILES) $(XML_APPLICATION_FILES) \ + $(XML_NOTES_FILES) + +# ---------------------------------------------------- +INFO_FILE = ../../info + +HTML_FILES = \ + $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \ + $(XML_PART_FILES:%.xml=$(HTMLDIR)/%.html) + +MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3) + + +HTML_REF_MAN_FILE = $(HTMLDIR)/index.html + +TOP_PDF_FILE = $(PDFDIR)/$(APPLICATION)-$(VSN).pdf + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- +XML_FLAGS += +DVIPS_FLAGS += + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- +$(HTMLDIR)/%.gif: %.gif + $(INSTALL_DATA) $< $@ + +docs: pdf html man + +$(TOP_PDF_FILE): $(XML_FILES) + +pdf: $(TOP_PDF_FILE) + +html: gifs $(HTML_REF_MAN_FILE) + +man: $(MAN3_FILES) + +$(XML_REF3_FILES): + docb_gen $(SRC_DIR)/$(@:%.xml=%.erl) + +$(XML_CHAPTER_FILES): + docb_gen -chapter -def vsn $(VSN) ../overview.edoc + +gifs: $(GIF_FILES:%=$(HTMLDIR)/%) + +xml: $(XML_REF3_FILES) $(XML_CHAPTER_FILES) + +debug opt: + +clean clean_docs: + rm -rf $(HTMLDIR)/* + rm -f $(MAN3DIR)/* + rm -f $(XML_REF3_FILES) $(XML_CHAPTER_FILES) *.html + rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) + rm -f errs core *~ + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + +release_docs_spec: docs + $(INSTALL_DIR) $(RELSYSDIR)/doc/pdf + $(INSTALL_DATA) $(TOP_PDF_FILE) $(RELSYSDIR)/doc/pdf + $(INSTALL_DIR) $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(HTMLDIR)/* \ + $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(INFO_FILE) $(RELSYSDIR) + $(INSTALL_DIR) $(RELEASE_PATH)/man/man3 + $(INSTALL_DATA) $(MAN3DIR)/* $(RELEASE_PATH)/man/man3 + +release_spec: diff --git a/lib/syntax_tools/doc/src/book.xml b/lib/syntax_tools/doc/src/book.xml new file mode 100644 index 0000000000..793b219ffb --- /dev/null +++ b/lib/syntax_tools/doc/src/book.xml @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE book SYSTEM "book.dtd"> + +<book xmlns:xi="http://www.w3.org/2001/XInclude"> + <header titlestyle="normal"> + <copyright> + <year>2006</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>Syntax_Tools</title> + <prepared></prepared> + <docno></docno> + <date></date> + <rev></rev> + </header> + <insidecover> + </insidecover> + <pagetext>Syntax_Tools</pagetext> + <preamble> + <contents level="2"></contents> + </preamble> + <parts lift="no"> + <xi:include href="part.xml"/> + </parts> + <applications> + <xi:include href="ref_man.xml"/> + </applications> + <releasenotes> + <xi:include href="notes.xml"/> + </releasenotes> + <listofterms></listofterms> + <index></index> +</book> + diff --git a/lib/syntax_tools/doc/src/fascicules.xml b/lib/syntax_tools/doc/src/fascicules.xml new file mode 100644 index 0000000000..0678195e07 --- /dev/null +++ b/lib/syntax_tools/doc/src/fascicules.xml @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE fascicules SYSTEM "fascicules.dtd"> + +<fascicules> + <fascicule file="part" href="part_frame.html" entry="no"> + User's Guide + </fascicule> + <fascicule file="ref_man" href="ref_man_frame.html" entry="yes"> + Reference Manual + </fascicule> + <fascicule file="part_notes" href="part_notes_frame.html" entry="no"> + Release Notes + </fascicule> + <fascicule file="" href="../../../../doc/print.html" entry="no"> + Off-Print + </fascicule> +</fascicules> + diff --git a/lib/syntax_tools/doc/src/make.dep b/lib/syntax_tools/doc/src/make.dep new file mode 100644 index 0000000000..acc76857bb --- /dev/null +++ b/lib/syntax_tools/doc/src/make.dep @@ -0,0 +1,22 @@ +# ---------------------------------------------------- +# >>>> Do not edit this file <<<< +# This file was automaticly generated by +# /home/otp/bin/docdepend +# ---------------------------------------------------- + + +# ---------------------------------------------------- +# TeX files that the DVI file depend on +# ---------------------------------------------------- + +book.dvi: book.tex chapter.tex epp_dodger.tex erl_comment_scan.tex \ + erl_prettypr.tex erl_recomment.tex erl_syntax.tex \ + erl_syntax_lib.tex erl_tidy.tex igor.tex part.tex \ + prettypr.tex ref_man.tex + +# ---------------------------------------------------- +# Source inlined when transforming from source to LaTeX +# ---------------------------------------------------- + +book.tex: ref_man.xml + diff --git a/lib/syntax_tools/doc/src/notes.xml b/lib/syntax_tools/doc/src/notes.xml new file mode 100644 index 0000000000..8fe21c8859 --- /dev/null +++ b/lib/syntax_tools/doc/src/notes.xml @@ -0,0 +1,176 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2007</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>Syntax_Tools Release Notes</title> + <prepared>otp_appnotes</prepared> + <docno>nil</docno> + <date>nil</date> + <rev>nil</rev> + <file>notes.xml</file> + </header> + <p>This document describes the changes made to the Syntax_Tools + application.</p> + +<section><title>Syntax_Tools 1.6.4</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + The documentation is now built with open source tools + (xsltproc and fop) that exists on most platforms. One + visible change is that the frames are removed.</p> + <p> + Own Id: OTP-8201</p> + </item> + </list> + </section> + +</section> + +<section><title>Syntax_Tools 1.6.3</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + Miscellaneous updates.</p> + <p> + Own Id: OTP-8190</p> + </item> + </list> + </section> + +</section> + +<section><title>Syntax_Tools 1.6.2</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + Miscellanous updates.</p> + <p> + Own Id: OTP-8038</p> + </item> + </list> + </section> + +</section> + +<section><title>Syntax_Tools 1.6</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + Miscellaneous updates.</p> + <p> + Own Id: OTP-7877</p> + </item> + </list> + </section> + +</section> + +<section><title>Syntax_Tools 1.5.6</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + Minor updates.</p> + <p> + Own Id: OTP-7642</p> + </item> + </list> + </section> + +</section> + + +<section><title>Syntax_Tools 1.5.5</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + Minor changes.</p> + <p> + Own Id: OTP-7388</p> + </item> + </list> + </section> + +</section> + +<section><title>Syntax_Tools 1.5.4</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + Minor updates, mostly cosmetic.</p> + <p> + Own Id: OTP-7243</p> + </item> + </list> + </section> + +</section> + + <section> + <title>Syntax_Tools 1.5.3</title> + + <section> + <title>Fixed Bugs and Malfunctions</title> + <list type="bulleted"> + <item> + <p>A missing directory (<c>examples</c>) has been added and + another broken link in the documentation has been fixed.</p> + <p>Own Id: OTP-6468</p> + </item> + </list> + </section> + </section> + + <section> + <title>Syntax_Tools 1.5.2</title> + + <section> + <title>Fixed Bugs and Malfunctions</title> + <list type="bulleted"> + <item> + <p>Fixed some broken links in the documentation.</p> + <p>Own Id: OTP-6420</p> + </item> + </list> + </section> + </section> + + <section> + <title>Syntax_Tools 1.5.1</title> + <p>Miscellaneous changes.</p> + </section> +</chapter> + diff --git a/lib/syntax_tools/doc/src/part.xml b/lib/syntax_tools/doc/src/part.xml new file mode 100644 index 0000000000..4a3bae29eb --- /dev/null +++ b/lib/syntax_tools/doc/src/part.xml @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE part SYSTEM "part.dtd"> + +<part xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <copyright> + <year>2006</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>Syntax_Tools User's Guide</title> + <prepared></prepared> + <docno></docno> + <date></date> + <rev></rev> + </header> + <description> + <p><em>Syntax_Tools</em> contains modules for handling abstract + Erlang syntax trees, in a way that is compatible with the "parse + trees" of the STDLIB module <c>erl_parse</c>, together with + utilities for reading source files in unusual ways and + pretty-printing syntax trees. Also included is an amazing module + merger and renamer called Igor, as well as an automatic + code-cleaner.</p> + </description> + <xi:include href="chapter.xml"/> +</part> + diff --git a/lib/syntax_tools/doc/src/part_notes.xml b/lib/syntax_tools/doc/src/part_notes.xml new file mode 100644 index 0000000000..3656b3ddb6 --- /dev/null +++ b/lib/syntax_tools/doc/src/part_notes.xml @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE part SYSTEM "part.dtd"> + +<part xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <copyright> + <year>2007</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>Syntax_Tools Release Notes</title> + <prepared></prepared> + <docno></docno> + <date></date> + <rev></rev> + </header> + <description> + <p><em>Syntax_Tools</em> contains modules for handling abstract + Erlang syntax trees, in a way that is compatible with the "parse + trees" of the STDLIB module <c>erl_parse</c>, together with + utilities for reading source files in unusual ways and + pretty-printing syntax trees. Also included is an amazing module + merger and renamer called Igor, as well as an automatic + code-cleaner.</p> + </description> + <xi:include href="notes.xml"/> +</part> + diff --git a/lib/syntax_tools/doc/src/ref_man.xml b/lib/syntax_tools/doc/src/ref_man.xml new file mode 100644 index 0000000000..9249b42184 --- /dev/null +++ b/lib/syntax_tools/doc/src/ref_man.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE application SYSTEM "application.dtd"> + +<application xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <copyright> + <year>2006</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>Syntax_Tools Reference Manual</title> + <prepared></prepared> + <docno></docno> + <date></date> + <rev></rev> + </header> + <description> + <p><em>Syntax_Tools</em> contains modules for handling abstract + Erlang syntax trees, in a way that is compatible with the "parse + trees" of the STDLIB module <c>erl_parse</c>, together with + utilities for reading source files in unusual ways and + pretty-printing syntax trees. Also included is an amazing module + merger and renamer called Igor, as well as an automatic + code-cleaner.</p> + </description> + <xi:include href="epp_dodger.xml"/> + <xi:include href="erl_comment_scan.xml"/> + <xi:include href="erl_prettypr.xml"/> + <xi:include href="erl_recomment.xml"/> + <xi:include href="erl_syntax.xml"/> + <xi:include href="erl_syntax_lib.xml"/> + <xi:include href="erl_tidy.xml"/> + <xi:include href="igor.xml"/> + <xi:include href="prettypr.xml"/> +</application> + |