From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- lib/syntax_tools/doc/Makefile | 91 +++++++++++++++++ lib/syntax_tools/doc/html/.gitignore | 0 lib/syntax_tools/doc/man3/.gitignore | 0 lib/syntax_tools/doc/overview.edoc | 76 ++++++++++++++ lib/syntax_tools/doc/pdf/.gitignore | 0 lib/syntax_tools/doc/src/Makefile | 137 +++++++++++++++++++++++++ lib/syntax_tools/doc/src/book.xml | 48 +++++++++ lib/syntax_tools/doc/src/fascicules.xml | 18 ++++ lib/syntax_tools/doc/src/make.dep | 22 ++++ lib/syntax_tools/doc/src/notes.xml | 176 ++++++++++++++++++++++++++++++++ lib/syntax_tools/doc/src/part.xml | 41 ++++++++ lib/syntax_tools/doc/src/part_notes.xml | 41 ++++++++ lib/syntax_tools/doc/src/ref_man.xml | 49 +++++++++ 13 files changed, 699 insertions(+) create mode 100644 lib/syntax_tools/doc/Makefile create mode 100644 lib/syntax_tools/doc/html/.gitignore create mode 100644 lib/syntax_tools/doc/man3/.gitignore create mode 100644 lib/syntax_tools/doc/overview.edoc create mode 100644 lib/syntax_tools/doc/pdf/.gitignore create mode 100644 lib/syntax_tools/doc/src/Makefile create mode 100644 lib/syntax_tools/doc/src/book.xml create mode 100644 lib/syntax_tools/doc/src/fascicules.xml create mode 100644 lib/syntax_tools/doc/src/make.dep create mode 100644 lib/syntax_tools/doc/src/notes.xml create mode 100644 lib/syntax_tools/doc/src/part.xml create mode 100644 lib/syntax_tools/doc/src/part_notes.xml create mode 100644 lib/syntax_tools/doc/src/ref_man.xml (limited to 'lib/syntax_tools/doc') diff --git a/lib/syntax_tools/doc/Makefile b/lib/syntax_tools/doc/Makefile new file mode 100644 index 0000000000..27f32988c8 --- /dev/null +++ b/lib/syntax_tools/doc/Makefile @@ -0,0 +1,91 @@ +# ``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 via the world wide web 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. +# +# The Initial Developer of the Original Code is Ericsson Utvecklings AB. +# Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings +# AB. All Rights Reserved.'' +# +# $Id: Makefile,v 1.1.1.1 2004/10/04 13:56:14 richardc Exp $ +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include ../vsn.mk +VSN=$(SYNTAX_TOOLS_VSN) + +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/lib/syntax_tools-$(VSN) + +# ---------------------------------------------------- +# Help application directory specification +# ---------------------------------------------------- + +APPNAME=syntax_tools +DOC_TITLE="Welcome to SyntaxTools" + +HTML_FILES = *.html +INFO_FILE = ../info +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- + + +docs: + (cd ..; \ + edoc_generate -app '$(APPNAME)' -vsn '$(VSN)') + + +info: + @echo "HTML_FILES:" $(HTML_FILES) + @echo "HTMLDIR: $(HTMLDIR)" + + + +debug opt: + + +clean: + rm -f $(HTML_FILES) stylesheet.css edoc-info + rm -f errs core *~ + + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- + + +include $(ERL_TOP)/make/otp_release_targets.mk + +release_docs_spec: docs + $(INSTALL_DIR) $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(HTML_FILES) $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(INFO_FILE) $(RELSYSDIR) + + +release_spec: + + + +# ---------------------------------------------------- +# Include dependency +# ---------------------------------------------------- +#-include make.dep + + diff --git a/lib/syntax_tools/doc/html/.gitignore b/lib/syntax_tools/doc/html/.gitignore new file mode 100644 index 0000000000..e69de29bb2 diff --git a/lib/syntax_tools/doc/man3/.gitignore b/lib/syntax_tools/doc/man3/.gitignore new file mode 100644 index 0000000000..e69de29bb2 diff --git a/lib/syntax_tools/doc/overview.edoc b/lib/syntax_tools/doc/overview.edoc new file mode 100644 index 0000000000..23eadce8fe --- /dev/null +++ b/lib/syntax_tools/doc/overview.edoc @@ -0,0 +1,76 @@ + +@author Richard Carlsson +@copyright 1997-2004 Richard Carlsson +@version {@version} +@title Erlang Syntax Tools + +@doc This package contains modules for handling abstract Erlang syntax +trees, in a way that is compatible with the "parse trees" of the +standard library module `erl_parse', 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. + +

The abstract layer (defined in {@link erl_syntax}) is nicely +structured and the node types are context-independent. The layer makes +it possible to transparently attach source-code comments and user +annotations to nodes of the tree. Using the abstract layer makes +applications less sensitive to changes in the {@link //stdlib/erl_parse} +data structures, only requiring the {@link erl_syntax} module to be +up-to-date.

+ +

The pretty printer {@link erl_prettypr} is implemented on top of the +library module {@link prettypr}: this is a powerful and flexible generic +pretty printing library, which is also distributed separately.

+ +

For a short demonstration of parsing and pretty-printing, simply +compile the included module demo.erl, and execute +demo:run() from the Erlang shell. It will compile the +remaining modules and give you further instructions.

+ +

Also try the {@link erl_tidy} module, as follows: +

+    erl_tidy:dir("any-erlang-source-dir", [test, old_guard_tests]).
+("test" assures that no files are modified).

+ +

News in 1.4: +

+

+ +

News in 1.3: +

+

+ +

News in 1.2: +

+

+ +

News in 1.1: +

+

diff --git a/lib/syntax_tools/doc/pdf/.gitignore b/lib/syntax_tools/doc/pdf/.gitignore new file mode 100644 index 0000000000..e69de29bb2 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 @@ + + + + +
+ + 20062009 + Ericsson AB. 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. + + + + Syntax_Tools + + + + +
+ + + Syntax_Tools + + + + + + + + + + + + + + + + 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 @@ + + + + + + User's Guide + + + Reference Manual + + + Release Notes + + + Off-Print + + + 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 @@ + + + + +
+ + 20072009 + Ericsson AB. 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. + + + + Syntax_Tools Release Notes + otp_appnotes + nil + nil + nil + notes.xml +
+

This document describes the changes made to the Syntax_Tools + application.

+ +
Syntax_Tools 1.6.4 + +
Improvements and New Features + + +

+ 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.

+

+ Own Id: OTP-8201

+ + +
+ +
+ +
Syntax_Tools 1.6.3 + +
Improvements and New Features + + +

+ Miscellaneous updates.

+

+ Own Id: OTP-8190

+ + +
+ +
+ +
Syntax_Tools 1.6.2 + +
Improvements and New Features + + +

+ Miscellanous updates.

+

+ Own Id: OTP-8038

+ + +
+ +
+ +
Syntax_Tools 1.6 + +
Improvements and New Features + + +

+ Miscellaneous updates.

+

+ Own Id: OTP-7877

+ + +
+ +
+ +
Syntax_Tools 1.5.6 + +
Improvements and New Features + + +

+ Minor updates.

+

+ Own Id: OTP-7642

+ + +
+ +
+ + +
Syntax_Tools 1.5.5 + +
Improvements and New Features + + +

+ Minor changes.

+

+ Own Id: OTP-7388

+ + +
+ +
+ +
Syntax_Tools 1.5.4 + +
Improvements and New Features + + +

+ Minor updates, mostly cosmetic.

+

+ Own Id: OTP-7243

+ + +
+ +
+ +
+ Syntax_Tools 1.5.3 + +
+ Fixed Bugs and Malfunctions + + +

A missing directory (examples) has been added and + another broken link in the documentation has been fixed.

+

Own Id: OTP-6468

+ + +
+
+ +
+ Syntax_Tools 1.5.2 + +
+ Fixed Bugs and Malfunctions + + +

Fixed some broken links in the documentation.

+

Own Id: OTP-6420

+ + +
+
+ +
+ Syntax_Tools 1.5.1 +

Miscellaneous changes.

+
+ + 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 @@ + + + + +
+ + 20062009 + Ericsson AB. 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. + + + + Syntax_Tools User's Guide + + + + +
+ +

Syntax_Tools contains modules for handling abstract + Erlang syntax trees, in a way that is compatible with the "parse + trees" of the STDLIB module erl_parse, 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.

+ + + + 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 @@ + + + + +
+ + 20072009 + Ericsson AB. 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. + + + + Syntax_Tools Release Notes + + + + +
+ +

Syntax_Tools contains modules for handling abstract + Erlang syntax trees, in a way that is compatible with the "parse + trees" of the STDLIB module erl_parse, 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.

+ + + + 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 @@ + + + + +
+ + 20062009 + Ericsson AB. 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. + + + + Syntax_Tools Reference Manual + + + + +
+ +

Syntax_Tools contains modules for handling abstract + Erlang syntax trees, in a way that is compatible with the "parse + trees" of the STDLIB module erl_parse, 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.

+ + + + + + + + + + + + -- cgit v1.2.3