From 6ddc5e7333ed60beca93a94d3ab0c302dcc472e2 Mon Sep 17 00:00:00 2001
From: Anders Svensson
Date: Fri, 29 Nov 2013 17:08:29 +0100
Subject: Fix documentation typos
---
lib/diameter/doc/src/diameter.xml | 14 +++++++-------
lib/diameter/doc/src/diameter_app.xml | 4 ++--
lib/diameter/doc/src/diameter_codec.xml | 8 ++++----
lib/diameter/doc/src/diameter_compile.xml | 4 ++--
lib/diameter/doc/src/diameter_dict.xml | 2 +-
lib/diameter/doc/src/diameter_intro.xml | 4 ++--
lib/diameter/doc/src/diameter_make.xml | 2 +-
lib/diameter/doc/src/diameter_sctp.xml | 2 +-
8 files changed, 20 insertions(+), 20 deletions(-)
(limited to 'lib/diameter/doc/src')
diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index db19fbb271..8740f7f4d2 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -575,7 +575,7 @@ The RFC 3539 watchdog state machine has
transitioned into (up) or out of (down) the OKAY
state.
If a #diameter_packet{} is present in an up event
-then there has been a capabilties exchange on a newly established
+then there has been a capabilities exchange on a newly established
transport connection and the record contains the received CER or CEA.
Otherwise a connection has reestablished without the loss or
connectivity.
@@ -584,7 +584,7 @@ connectivity.
Note that a single -
-AVP's used to construct outgoing CER/CEA messages.
+AVPs used to construct outgoing CER/CEA messages.
Values take precedence over any specified on the service in
question.
@@ -1661,7 +1661,7 @@ R_Flag}.
Note that watchdog, peer, apps, caps
and port entries depend on connectivity
with the peer and may not be present.
-Note also that the statistics entry presents values acuumulated
+Note also that the statistics entry presents values accumulated
during the lifetime of the transport configuration.
diff --git a/lib/diameter/doc/src/diameter_app.xml b/lib/diameter/doc/src/diameter_app.xml
index e6c9cc9a90..0b6839dcb2 100644
--- a/lib/diameter/doc/src/diameter_app.xml
+++ b/lib/diameter/doc/src/diameter_app.xml
@@ -308,7 +308,7 @@ The return value {Peer, NewState} is only allowed if
the Diameter application in question was configured with the
&mod_application_opt; {call_mutates_state, true}.
Otherwise, the State argument is always
-the intial value as configured on the application, not any subsequent
+the initial value as configured on the application, not any subsequent
value returned by a &peer_up;
or &peer_down; callback.
@@ -565,7 +565,7 @@ Equivalent to
where Avps sets the Origin-Host, Origin-Realm, the specified
-Result-Code and (if the request contained one) Session-Id AVP's, and
+Result-Code and (if the request contained one) Session-Id AVPs, and
possibly Failed-AVP as described below.
diff --git a/lib/diameter/doc/src/diameter_codec.xml b/lib/diameter/doc/src/diameter_codec.xml
index 4a77d5435b..9d26466b25 100644
--- a/lib/diameter/doc/src/diameter_codec.xml
+++ b/lib/diameter/doc/src/diameter_codec.xml
@@ -13,7 +13,7 @@
-2012
+20122013
Ericsson AB. All Rights Reserved.
@@ -73,7 +73,7 @@ are defined in diameter.hrl, which can be included as follows.
-Application-specific records are definied in the hrl
+Application-specific records are defined in the hrl
files resulting from dictionary file compilation.
@@ -122,7 +122,7 @@ Fields have the following types.
-
Values in the AVP header, corresponding to AVP Code, the M flag, P
-flags and Vendor-ID respectivelty.
+flags and Vendor-ID respectively.
A Vendor-ID other than undefined implies a set V flag.
@@ -222,7 +222,7 @@ header.
is_retransmitted = boolean()
-
-Values correspoding to the R(equest), P(roxiable), E(rror)
+Values corresponding to the R(equest), P(roxiable), E(rror)
and T(Potentially re-transmitted message) flags of the Diameter
header.
diff --git a/lib/diameter/doc/src/diameter_compile.xml b/lib/diameter/doc/src/diameter_compile.xml
index 6630019e5c..820bde6986 100644
--- a/lib/diameter/doc/src/diameter_compile.xml
+++ b/lib/diameter/doc/src/diameter_compile.xml
@@ -41,7 +41,7 @@ supplied.
The diameterc utility is used to compile a diameter
&dictionary; into Erlang source.
The resulting source implements the interface diameter required
-to encode and decode the dictionary's messages and AVP's.
+to encode and decode the dictionary's messages and AVPs.
The module &man_make; provides an alternate compilation interface.
@@ -83,7 +83,7 @@ Defaults to the current working directory.
-
-Supress erl and hrl generation, respectively.
+Suppress erl and hrl generation, respectively.
]]>
diff --git a/lib/diameter/doc/src/diameter_dict.xml b/lib/diameter/doc/src/diameter_dict.xml
index 8bf4a14240..4f51a12ebc 100644
--- a/lib/diameter/doc/src/diameter_dict.xml
+++ b/lib/diameter/doc/src/diameter_dict.xml
@@ -431,7 +431,7 @@ equivalent to specifying it with @avp_vendor_id.
Defines values of AVP Name having type Enumerated.
Section content consists of names and corresponding integer values.
Integer values can be prefixed with 0x to be interpreted as
-hexidecimal.
+hexadecimal.
Note that the AVP in question can be defined in an inherited
diff --git a/lib/diameter/doc/src/diameter_intro.xml b/lib/diameter/doc/src/diameter_intro.xml
index 288ebc0c7c..6c1d1910d2 100644
--- a/lib/diameter/doc/src/diameter_intro.xml
+++ b/lib/diameter/doc/src/diameter_intro.xml
@@ -40,7 +40,7 @@ under the License.
The diameter application is an implementation of the Diameter protocol
as defined by &the_rfc;.
It supports arbitrary Diameter applications by way of a
-dictionary interface that allows messages and AVP's to be
+dictionary interface that allows messages and AVPs to be
defined and input into diameter as configuration.
It has support for all roles defined in the RFC: client, server and
agent.
@@ -69,7 +69,7 @@ interface.
While a service typically implements a single Diameter node (as
identified by an Origin-Host AVP), transports can themselves be
-associated with capabilities AVP's so that a single service can be
+associated with capabilities AVPs so that a single service can be
used to implement more than one Diameter node.
diff --git a/lib/diameter/doc/src/diameter_make.xml b/lib/diameter/doc/src/diameter_make.xml
index ec71251be1..83ef42552a 100644
--- a/lib/diameter/doc/src/diameter_make.xml
+++ b/lib/diameter/doc/src/diameter_make.xml
@@ -51,7 +51,7 @@ under the License.
The function &codec; is used to compile a diameter
&dictionary; into Erlang source.
The resulting source implements the interface diameter required
-to encode and decode the dictionary's messages and AVP's.
+to encode and decode the dictionary's messages and AVPs.
The utility &man_compile; provides an alternate compilation
diff --git a/lib/diameter/doc/src/diameter_sctp.xml b/lib/diameter/doc/src/diameter_sctp.xml
index 5fe14b1ef6..2be77e3dfd 100644
--- a/lib/diameter/doc/src/diameter_sctp.xml
+++ b/lib/diameter/doc/src/diameter_sctp.xml
@@ -90,7 +90,7 @@ Options raddr and rport specify the remote address
and port for a connecting transport and not valid for a listening
transport: the former is required while latter defaults to 3868 if
unspecified.
-Mupltiple raddr options can be specified, in which case the
+Multiple raddr options can be specified, in which case the
connecting transport in question attempts each in sequence until
an association is established.
--
cgit v1.2.3
From fce38d77ec95261ec7ae3694d0b5db91f1cb39c2 Mon Sep 17 00:00:00 2001
From: Anders Svensson
Date: Sat, 30 Nov 2013 20:02:12 +0100
Subject: Generate diameterc.1, not diameter_compile.1
---
lib/diameter/doc/src/diameter_compile.xml | 149 ------------------------------
lib/diameter/doc/src/diameterc.xml | 149 ++++++++++++++++++++++++++++++
lib/diameter/doc/src/files.mk | 2 +-
lib/diameter/doc/src/ref_man.xml | 4 +-
4 files changed, 152 insertions(+), 152 deletions(-)
delete mode 100644 lib/diameter/doc/src/diameter_compile.xml
create mode 100644 lib/diameter/doc/src/diameterc.xml
(limited to 'lib/diameter/doc/src')
diff --git a/lib/diameter/doc/src/diameter_compile.xml b/lib/diameter/doc/src/diameter_compile.xml
deleted file mode 100644
index 820bde6986..0000000000
--- a/lib/diameter/doc/src/diameter_compile.xml
+++ /dev/null
@@ -1,149 +0,0 @@
-
-dictionary file'>
-
-
- %also;
- %here;
-]>
-
-
-
-
-20112013
-Ericsson AB. All Rights Reserved.
-
-
-
-The program may be used and/or copied only with the written permission
-from Ericsson AB, or in accordance with the terms and conditions
-stipulated in the agreement/contract under which the program has been
-supplied.
-
-
-
-diameterc(1)
-
-
-
-
-
-diameter_compile.xml
-
-
-diameterc
-] ]]>
-
-
-
-
-The diameterc utility is used to compile a diameter
-&dictionary; into Erlang source.
-The resulting source implements the interface diameter required
-to encode and decode the dictionary's messages and AVPs.
-
-
-The module &man_make; provides an alternate compilation interface.
-
-
-
-
-USAGE
-
-
-
-] ]]>
--
-
-Compile a single dictionary file to Erlang source.
-Valid options are as follows.
-
-
-]]>
--
-
-Prepend the specified directory to the code path.
-Use to point at beam files compiled from inherited dictionaries,
-&dict_inherits; in a dictionary file creating a beam
-dependency, not an erl/hrl dependency.
-
-
-Multiple -i options can be specified.
-
-
-]]>
--
-
-Write generated source to the specified directory.
-Defaults to the current working directory.
-
-
-
-
--
-
-Suppress erl and hrl generation, respectively.
-
-
-]]>
-]]>
--
-
-Transform the input dictionary before compilation, setting
-&dict_name; or &dict_prefix; to the specified
-string.
-
-
-]]>
--
-
-Transform the input dictionary before compilation, appending
-&dict_inherits; of the specified string.
-
-
-Two forms of --inherits have special meaning:
-
-
---inherits -
---inherits Prev/Mod
-
-
-
-The first has the effect of clearing any previous inherits, the second
-of replacing a previous inherits of Prev to one of Mod.
-This allows the semantics of the input dictionary to be changed without
-modifying the file itself.
-
-
-Multiple --inherits options can be specified.
-
-
-
-
-
-
-
-
-
-
-
-
-EXIT STATUS
-
-
-Returns 0 on success, non-zero on failure.
-
-
-
-
-
-
-SEE ALSO
-
-
-&man_make;, &man_dict;
-
-
-
-
diff --git a/lib/diameter/doc/src/diameterc.xml b/lib/diameter/doc/src/diameterc.xml
new file mode 100644
index 0000000000..039f4f9cdd
--- /dev/null
+++ b/lib/diameter/doc/src/diameterc.xml
@@ -0,0 +1,149 @@
+
+dictionary file'>
+
+
+ %also;
+ %here;
+]>
+
+
+
+
+20112013
+Ericsson AB. All Rights Reserved.
+
+
+
+The program may be used and/or copied only with the written permission
+from Ericsson AB, or in accordance with the terms and conditions
+stipulated in the agreement/contract under which the program has been
+supplied.
+
+
+
+diameterc(1)
+
+
+
+
+
+diameterc.xml
+
+
+diameterc
+] ]]>
+
+
+
+
+The diameterc utility is used to compile a diameter
+&dictionary; into Erlang source.
+The resulting source implements the interface diameter required
+to encode and decode the dictionary's messages and AVPs.
+
+
+The module &man_make; provides an alternate compilation interface.
+
+
+
+
+USAGE
+
+
+
+] ]]>
+-
+
+Compile a single dictionary file to Erlang source.
+Valid options are as follows.
+
+
+]]>
+-
+
+Prepend the specified directory to the code path.
+Use to point at beam files compiled from inherited dictionaries,
+&dict_inherits; in a dictionary file creating a beam
+dependency, not an erl/hrl dependency.
+
+
+Multiple -i options can be specified.
+
+
+]]>
+-
+
+Write generated source to the specified directory.
+Defaults to the current working directory.
+
+
+
+
+-
+
+Suppress erl and hrl generation, respectively.
+
+
+]]>
+]]>
+-
+
+Transform the input dictionary before compilation, setting
+&dict_name; or &dict_prefix; to the specified
+string.
+
+
+]]>
+-
+
+Transform the input dictionary before compilation, appending
+&dict_inherits; of the specified string.
+
+
+Two forms of --inherits have special meaning:
+
+
+--inherits -
+--inherits Prev/Mod
+
+
+
+The first has the effect of clearing any previous inherits, the second
+of replacing a previous inherits of Prev to one of Mod.
+This allows the semantics of the input dictionary to be changed without
+modifying the file itself.
+
+
+Multiple --inherits options can be specified.
+
+
+
+
+
+
+
+
+
+
+
+
+EXIT STATUS
+
+
+Returns 0 on success, non-zero on failure.
+
+
+
+
+
+
+SEE ALSO
+
+
+&man_make;, &man_dict;
+
+
+
+
diff --git a/lib/diameter/doc/src/files.mk b/lib/diameter/doc/src/files.mk
index 510786a7fb..6e8b1f9068 100644
--- a/lib/diameter/doc/src/files.mk
+++ b/lib/diameter/doc/src/files.mk
@@ -21,7 +21,7 @@ XML_APPLICATION_FILES = \
ref_man.xml
XML_REF1_FILES = \
- diameter_compile.xml
+ diameterc.xml
XML_REF3_FILES = \
diameter.xml \
diff --git a/lib/diameter/doc/src/ref_man.xml b/lib/diameter/doc/src/ref_man.xml
index 4b99fe716d..1095887144 100644
--- a/lib/diameter/doc/src/ref_man.xml
+++ b/lib/diameter/doc/src/ref_man.xml
@@ -6,7 +6,7 @@
2011
-2012
+2013
Ericsson AB. All Rights Reserved.
@@ -39,7 +39,7 @@ applications on top of the Diameter protocol.
-
+
--
cgit v1.2.3