diff options
Diffstat (limited to 'lib/megaco/doc/src')
| -rw-r--r-- | lib/megaco/doc/src/Makefile | 20 | ||||
| -rw-r--r-- | lib/megaco/doc/src/megaco_codec_transform.xml | 27 | ||||
| -rw-r--r-- | lib/megaco/doc/src/megaco_debug.xml | 28 | ||||
| -rw-r--r-- | lib/megaco/doc/src/megaco_performance.xml | 18 | ||||
| -rw-r--r-- | lib/megaco/doc/src/notes.xml | 42 |
5 files changed, 62 insertions, 73 deletions
diff --git a/lib/megaco/doc/src/Makefile b/lib/megaco/doc/src/Makefile index 2c55e92914..a82256b372 100644 --- a/lib/megaco/doc/src/Makefile +++ b/lib/megaco/doc/src/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2000-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2000-2010. 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 @@ -49,6 +49,9 @@ include files.mk # ---------------------------------------------------- +XML_FILES = $(BOOK_FILES) $(XML_APPLICATION_FILES) $(XML_REF3_FILES) \ + $(XML_PART_FILES) $(XML_CHAPTER_FILES) + INTERNAL_HTML_FILES = $(TECHNICAL_DESCR_FILES:%.xml=$(HTMLDIR)/%.html) HTML_APP_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) @@ -104,8 +107,11 @@ INDEX_SRC = $(INDEX_FILE).src INDEX_TARGET = $(DOCDIR)/$(INDEX_FILE) STANDARD_DIR = ../standard -STANDARDS = $(STANDARD_DIR)/rfc3015.txt \ - $(STANDARD_DIR)/implementors_guide_v6.pdf +STANDARDS = $(STANDARD_DIR)/rfc3266.txt \ + $(STANDARD_DIR)/rfc3525.txt \ + $(STANDARD_DIR)/rfc4234.txt \ + $(STANDARD_DIR)/rfc4566.txt \ + $(STANDARD_DIR)/implementors_guide_v10-13.pdf # ---------------------------------------------------- # FLAGS diff --git a/lib/megaco/doc/src/megaco_codec_transform.xml b/lib/megaco/doc/src/megaco_codec_transform.xml index 71f7fc689f..89ed3fd654 100644 --- a/lib/megaco/doc/src/megaco_codec_transform.xml +++ b/lib/megaco/doc/src/megaco_codec_transform.xml @@ -4,7 +4,7 @@ <erlref> <header> <copyright> - <year>2002</year><year>2009</year> + <year>2002</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ 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>megaco_codec_transform</title> @@ -36,8 +36,8 @@ <description> <p>This module implements a simple megaco message transformation utility.</p> - <p><em>Note</em> that this module is <em>not</em> included in the runtime part of - the application.</p> + <p><em>Note</em> that this module is <em>not</em> included in the + runtime part of the application.</p> <marker id="export_messages"></marker> </description> @@ -51,15 +51,16 @@ <v>MessagePackage = atom()</v> </type> <desc> - <p>Export the messages in the <c>MessagePackage</c> (default is <c>time_test</c>). </p> - <p>The out produced by this function is a directory structure with the - following structure: </p> + <p>Export the messages in the <c>MessagePackage</c> (default + is <c>time_test</c>). </p> + <p>The output produced by this function is a directory structure + with the following structure: </p> <code type="none"><![CDATA[ -\011 <message package>/pretty/<message-files> -\011 compact/<message-files> -\011 per/<message-files> -\011 ber/<message-files> -\011 erlang/<message-files> +<message package>/pretty/<message-files> + compact/<message-files> + per/<message-files> + ber/<message-files> + erlang/<message-files> ]]></code> </desc> </func> diff --git a/lib/megaco/doc/src/megaco_debug.xml b/lib/megaco/doc/src/megaco_debug.xml index 1b99985341..2523a3be86 100644 --- a/lib/megaco/doc/src/megaco_debug.xml +++ b/lib/megaco/doc/src/megaco_debug.xml @@ -4,7 +4,7 @@ <chapter> <header> <copyright> - <year>2000</year><year>2009</year> + <year>2000</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ 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>Testing and tools</title> @@ -159,12 +159,12 @@ <p>When run as above (this will take some time), the measurement process is done as follows:</p> <pre> -\011 For each codec: -\011 For each message: -\011 Read the message from the file -\011 Detect message version -\011 Measure decode - Measure encode +For each codec: + For each message: + Read the message from the file + Detect message version + Measure decode + Measure encode Write results, encode, decode and total, to file </pre> </item> @@ -218,11 +218,11 @@ message() = binary() with the following structure: </p> <code type="none"><![CDATA[ -\011 <message package>/pretty/<message-files> -\011 compact/ -\011 per/ -\011 ber/<message-files> -\011 erlang/ +<message package>/pretty/<message-files> + compact/ + per/ + ber/<message-files> + erlang/ ]]></code> <p>The file includes both version 1, 2 and version 3 messages.</p> </section> diff --git a/lib/megaco/doc/src/megaco_performance.xml b/lib/megaco/doc/src/megaco_performance.xml index b34ee4f389..72b5c156ba 100644 --- a/lib/megaco/doc/src/megaco_performance.xml +++ b/lib/megaco/doc/src/megaco_performance.xml @@ -4,7 +4,7 @@ <chapter> <header> <copyright> - <year>2002</year><year>2009</year> + <year>2002</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ 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>Performance comparison</title> @@ -257,12 +257,12 @@ MEGACO/1 [124.124.124.222] Transaction = 9998 { Context = - { ServiceChange = ROOT { - \011Services { - \011 Method = Restart, - \011 ServiceChangeAddress = 55555, - \011 Profile = ResGW/1, - \011 Reason = "901 MG Cold Boot" - \011} + Services { + Method = Restart, + ServiceChangeAddress = 55555, + Profile = ResGW/1, + Reason = "901 MG Cold Boot" + } } } } </pre> diff --git a/lib/megaco/doc/src/notes.xml b/lib/megaco/doc/src/notes.xml index bacb7275d7..61f3611029 100644 --- a/lib/megaco/doc/src/notes.xml +++ b/lib/megaco/doc/src/notes.xml @@ -4,7 +4,7 @@ <chapter> <header> <copyright> - <year>2000</year><year>2009</year> + <year>2000</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ 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>Megaco Release Notes</title> @@ -36,27 +36,27 @@ section is the version number of Megaco.</p> <section> - <title>Megaco 3.13.0.1</title> + <title>Megaco 3.13.0.2</title> - <p>Version 3.13.0.1 supports code replacement in runtime from/to + <p>Version 3.13.0.2 supports code replacement in runtime from/to version 3.13, 3.12 and 3.11.3.</p> <section> <title>Improvements and new features</title> +<!-- <p>-</p> +--> -<!-- <list type="bulleted"> <item> - <p>The documentation is now built with open source tools - (<em>xsltproc</em> and <em>fop</em>) that exists on most - platforms. One visible change is that the frames are removed.</p> - <p>Own Id: OTP-8249</p> + <p>Added a help target in the test Makefile to explain + the most useful make targets, used when testing the + application using the test-server provided with megaco.</p> + <p>Own Id: OTP-8362</p> </item> </list> ---> </section> @@ -75,25 +75,7 @@ </section> - <section> - <title>Incompatibilities</title> - <p>-</p> - -<!-- - <list type="bulleted"> - <item> - <p>For those implementing their own codec's, the new megaco_encoder - behaviour will require three more functions. See above for more - info. </p> - <p>Own Id: OTP-7168</p> - <p>Aux Id: Seq 10867</p> - </item> - - </list> ---> - - </section> - </section> <!-- 3.13.0.1 --> + </section> <!-- 3.13.0.2 --> <section> |