From a2f9fa00d184d89619bfd61313387a943f9dd19e Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Fri, 26 Aug 2016 08:15:26 +0200 Subject: Fix xmllint errors in documentation --- lib/diameter/doc/src/diameter.xml | 138 ++++++++++++++-------------- lib/diameter/doc/src/diameter_app.xml | 39 +++----- lib/diameter/doc/src/diameter_codec.xml | 56 +++++------ lib/diameter/doc/src/diameter_dict.xml | 67 ++++++-------- lib/diameter/doc/src/diameter_examples.xml | 1 - lib/diameter/doc/src/diameter_transport.xml | 9 +- lib/diameter/doc/src/diameterc.xml | 6 +- 7 files changed, 143 insertions(+), 173 deletions(-) diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index f9f3839094..72181a42b0 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -94,12 +94,12 @@ in this module.

-Address() -DiameterIdentity() -Grouped() -OctetString() -Time() -Unsigned32() +Address() +DiameterIdentity() +Grouped() +OctetString() +Time() +Unsigned32() UTF8String()

@@ -338,8 +338,8 @@ Has one of the following types.

-{'Origin-Host', &dict_DiameterIdentity;} -{'Origin-Realm', &dict_DiameterIdentity;} +{'Origin-Host', &dict_DiameterIdentity;} +{'Origin-Realm', &dict_DiameterIdentity;} {'Host-IP-Address', [&dict_Address;]}

@@ -351,8 +351,8 @@ question communicates an address list as described in &man_transport;

 -{'Vendor-Id', &dict_Unsigned32;} -{'Product-Name', &dict_UTF8String;} +{'Vendor-Id', &dict_Unsigned32;} +{'Product-Name', &dict_UTF8String;} {'Origin-State-Id', &dict_Unsigned32;}

@@ -365,8 +365,8 @@ can be used as to retrieve a value that is computed when the diameter application is started.

 -{'Supported-Vendor-Id', [&dict_Unsigned32;]} -{'Auth-Application-Id', [&dict_Unsigned32;]} +{'Supported-Vendor-Id', [&dict_Unsigned32;]} +{'Auth-Application-Id', [&dict_Unsigned32;]} {'Inband-Security-Id', [&dict_Unsigned32;]}

@@ -376,9 +376,9 @@ If 1 (TLS) is specified then TLS is selected if the CER/CEA received from the peer offers it.

 -{'Acct-Application-Id', [&dict_Unsigned32;]} -{'Vendor-Specific-Application-Id', [&dict_Grouped;]} -{'Firmware-Revision', &dict_Unsigned32;} +{'Acct-Application-Id', [&dict_Unsigned32;]} +{'Vendor-Specific-Application-Id', [&dict_Grouped;]} +{'Firmware-Revision', &dict_Unsigned32;} @@ -566,9 +566,8 @@ Can have one of the following types.

-start +start stop -

The service is being started or stopped. @@ -577,8 +576,8 @@ No event follows a stop event, and this event implies the termination of all transport processes.

 -{up, Ref, Peer, Config, Pkt} -{up, Ref, Peer, Config} +{up, Ref, Peer, Config, Pkt} +{up, Ref, Peer, Config} {down, Ref, Peer, Config} 
@@ -787,8 +786,8 @@ be matched by corresponding &capability; configuration, of
 
 
 
-
-{incoming_maxlen, 0..16777215}
+
+{incoming_maxlen, 0..16777215}
 
 

 Bound on the expected size of incoming Diameter messages.
@@ -916,8 +915,8 @@ Options monitor and link are ignored.

 Defaults to the empty list.

 
 
-
-{strict_mbit, boolean()}
+
+{strict_mbit, boolean()}
 
 

 Whether or not to regard an AVP setting the M-bit as erroneous when
@@ -934,7 +933,7 @@ Defaults to true.

 

 RFC 6733 is unclear about the semantics of the M-bit.
 One the one hand, the CCF specification in section 3.2 documents AVP
-in a command grammar as meaning any arbitrary AVP; on the
+in a command grammar as meaning any arbitrary AVP; on the
 other hand, 1.3.4 states that AVPs setting the M-bit cannot be added
 to an existing command: the modified command must instead be
 placed in a new Diameter application.

@@ -944,7 +943,7 @@ allowing arbitrary AVPs setting the M-bit in a command makes its
 interpretation implementation-dependent, since there's no
 guarantee that all implementations will understand the same set of
 arbitrary AVPs in the context of a given command.
-However, interpreting AVP in a command grammar as any
+However, interpreting AVP in a command grammar as any
 AVP, regardless of M-bit, renders 1.3.4 meaningless, since the receiver
 can simply ignore any AVP it thinks isn't relevant, regardless of the
 sender's intent.

@@ -959,8 +958,8 @@ occur in the message in question.

 
 
 
-
-{string_decode, boolean()}
+
+{string_decode, boolean()}
 
 

 Whether or not to decode AVPs of type &dict_OctetString; and its
@@ -1030,8 +1029,9 @@ Option passed to &add_transport;.
 Has one of the following types.

 
 
-
-{applications, [&application_alias;]}
+
+
+{applications, [&application_alias;]}
 
 

 Diameter applications to which the transport should be restricted.
@@ -1049,8 +1049,8 @@ implies having to set matching *-Application-Id AVPs in a
 
 
 
-
-{capabilities, [&capability;]}
+
+{capabilities, [&capability;]}
 
 

 AVPs used to construct outgoing CER/CEA messages.
@@ -1063,8 +1063,8 @@ may be particularly appropriate for Inband-Security-Id, in case
 TLS is desired over TCP as implemented by &man_tcp;.

 
 
-
-{capabilities_cb, &evaluable;}
+
+{capabilities_cb, &evaluable;}
 
 

 Callback invoked upon reception of CER/CEA during capabilities
@@ -1111,8 +1111,8 @@ case the corresponding callbacks are applied until either all return
 ok or one does not.

 
 
-
-{capx_timeout, &dict_Unsigned32;}
+
+{capx_timeout, &dict_Unsigned32;}
 
 

 Number of milliseconds after which a transport process having an
@@ -1126,8 +1126,8 @@ For a listening transport, the peer determines the timing.

 Defaults to 10000.

 
 
-
-{connect_timer, Tc}
+
+{connect_timer, Tc}
 
 
 Tc = &dict_Unsigned32;
@@ -1157,9 +1157,8 @@ Defaults to 30000 for a connecting transport and 60000 for a listening
 transport.

 
 
-
-{disconnect_cb, &evaluable;}
-
+
+{disconnect_cb, &evaluable;}
 
 

 Callback invoked prior to terminating the transport process of a
@@ -1235,8 +1234,8 @@ configured them.

 Defaults to a single callback returning dpr.

 
 
-
-{dpa_timeout, &dict_Unsigned32;}
+
+{dpa_timeout, &dict_Unsigned32;}
 
 

 Number of milliseconds after which a transport connection is
@@ -1246,8 +1245,8 @@ terminated following an outgoing DPR if DPA is not received.

 Defaults to 1000.

 
 
-
-{dpr_timeout, &dict_Unsigned32;}
+
+{dpr_timeout, &dict_Unsigned32;}
 
 

 Number of milliseconds after which a transport connection is
@@ -1258,8 +1257,8 @@ connection.

 Defaults to 5000.

 
 
-
-{length_errors, exit|handle|discard}
+
+{length_errors, exit|handle|discard}
 
 

 How to deal with errors in the Message Length field of the
@@ -1307,8 +1306,8 @@ the same peer.

 
 
 
-
-{spawn_opt, [term()]}
+
+{spawn_opt, [term()]}
 
 

 Options passed to &spawn_opt; when spawning a process for an
@@ -1319,8 +1318,8 @@ Options monitor and link are ignored.

 Defaults to the list configured on the service if not specified.

 
 
-
-{transport_config, term()}
+
+{transport_config, term()}
 {transport_config, term(), &dict_Unsigned32; | infinity}
 
 

@@ -1348,8 +1347,8 @@ request a connection with one peer over SCTP or another
 To listen on both SCTP and TCP, define one transport for each.

 
 
-
-{transport_module, atom()}
+
+{transport_module, atom()}
 
 

 Module implementing a transport process as defined in &man_transport;.
@@ -1368,8 +1367,9 @@ modules in order until one establishes a connection within the
 corresponding timeout (see below) or all fail.

 
 
-
-{watchdog_config, [{okay|suspect, non_neg_integer()}]}
+
+{watchdog_config,
+                       [{okay|suspect, non_neg_integer()}]}
 
 

 Configuration that alters the behaviour of the watchdog
@@ -1392,8 +1392,8 @@ misbehaving nodes during test.

 
 
 
-
-{watchdog_timer, TwInit}
+
+{watchdog_timer, TwInit}
 
 
 TwInit = &dict_Unsigned32;
@@ -1421,10 +1421,10 @@ Unrecognized options are silently ignored but are returned unmodified
 by &service_info; and can be referred to
 in predicate functions passed to &remove_transport;.

 
-
 
 
-transport_ref() = reference()
+
+transport_ref() = reference()
 
 

 Reference returned by &add_transport; that
@@ -1681,17 +1681,17 @@ returned.

 
 
 
-'Origin-Host'
-'Origin-Realm'
-'Vendor-Id'
-'Product-Name'
-'Origin-State-Id'
-'Host-IP-Address'
-'Supported-Vendor'
-'Auth-Application-Id'
-'Inband-Security-Id'
-'Acct-Application-Id'
-'Vendor-Specific-Application-Id'
+'Origin-Host'
+'Origin-Realm'
+'Vendor-Id'
+'Product-Name'
+'Origin-State-Id'
+'Host-IP-Address'
+'Supported-Vendor'
+'Auth-Application-Id'
+'Inband-Security-Id'
+'Acct-Application-Id'
+'Vendor-Specific-Application-Id'
 'Firmware-Revision'
 
 

diff --git a/lib/diameter/doc/src/diameter_app.xml b/lib/diameter/doc/src/diameter_app.xml
index 973b6eb732..dfcd00975b 100644
--- a/lib/diameter/doc/src/diameter_app.xml
+++ b/lib/diameter/doc/src/diameter_app.xml
@@ -90,17 +90,14 @@ is called in response to an incoming Diameter request message.

 
 
 
-
-
-
 

-The arities given for the the callback functions here assume no extra
-arguments.
+The arities for the the callback functions here assume no extra arguments.
 All functions will also be passed any extra arguments configured with
 the callback module itself when calling &mod_start_service;
 and, for the call-specific callbacks, any extra arguments passed to
 &mod_call;.

-
+
+
 
 
 
@@ -110,9 +107,8 @@ and, for the call-specific callbacks, any extra arguments passed to
 
 
 
-
-
-capabilities() = #diameter_caps{}
+
+capabilities() = #diameter_caps{}
 
 

 A record containing the identities of
@@ -126,9 +122,8 @@ Optional or possibly multiple values are encoded as lists of values,
 mandatory values as the bare value.

 
 
-
-
-message() = &codec_message;
+
+message() = &codec_message;
 
 

 The representation of a Diameter message as passed to
@@ -136,9 +131,8 @@ The representation of a Diameter message as passed to
 
 
 
-
-
-packet() = &codec_packet;
+
+packet() = &codec_packet;
 
 

 A container for incoming and outgoing Diameter messages that's passed
@@ -146,25 +140,22 @@ through encode/decode and transport.
 Fields should not be set in return values except as documented.

 
 
-
-
-peer_ref() = term()
+
+peer_ref() = term()
 
 

 A term identifying a transport connection with a Diameter peer.

 
 
-
-
-peer() = {&peer_ref;, &capabilities;}
+
+peer() = {&peer_ref;, &capabilities;}
 
 

 A tuple representing a Diameter peer connection.

 
 
-
-
-state() = term()
+
+state() = term()
 
 

 The state maintained by the application callback functions
diff --git a/lib/diameter/doc/src/diameter_codec.xml b/lib/diameter/doc/src/diameter_codec.xml
index a0313e2877..91e96058dd 100644
--- a/lib/diameter/doc/src/diameter_codec.xml
+++ b/lib/diameter/doc/src/diameter_codec.xml
@@ -88,10 +88,9 @@ files resulting from dictionary file compilation.

 
 
 
-
-
-uint8()  = 0..255
-uint24() = 0..16777215
+
+uint8()  = 0..255
+uint24() = 0..16777215
 uint32() = 0..4294967295
 
 

@@ -99,9 +98,8 @@ files resulting from dictionary file compilation.

 headers.

 
 
-
-
-avp() = #diameter_avp{}
+
+avp() = #diameter_avp{}
 
 

 The application-neutral representation of an AVP.
@@ -116,9 +114,9 @@ Fields have the following types.

 
 
 
-code = uint32()
-is_mandatory = boolean()
-need_encryption = boolean()
+code = uint32()
+is_mandatory = boolean()
+need_encryption = boolean()
 vendor_id = uint32() | undefined
 
 

@@ -167,9 +165,8 @@ Possible types are undefined and the Diameter types:
 
 
 
-
-
-dictionary() = module()
+
+dictionary() = module()
 
 
 

@@ -179,9 +176,8 @@ The interface provided by a dictionary module is an
 implementation detail that may change.

 
 
-
-
-header() = #diameter_header{}
+
+header() = #diameter_header{}
 
 

 The record representation of the Diameter header.
@@ -204,11 +200,11 @@ Fields have the following types.

 
 
 
-version = uint8()
-length = uint24()
-cmd_code = uint24()
-application_id = uint32()
-hop_by_hop_id = uint32()
+version = uint8()
+length = uint24()
+cmd_code = uint24()
+application_id = uint32()
+hop_by_hop_id = uint32()
 end_to_end_id = uint32()
 
 

@@ -217,9 +213,9 @@ Hop-by-Hop Identifier and End-to-End Identifier fields of the Diameter
 header.

 
 
-is_request = boolean()
-is_proxiable = boolean()
-is_error = boolean()
+is_request = boolean()
+is_proxiable = boolean()
+is_error = boolean()
 is_retransmitted = boolean()
 
 

@@ -232,9 +228,8 @@ header.

 
 
 
-
-
-message() = record() | list()
+
+message() = record() | list()
 
 

 The representation of a Diameter message as passed to
@@ -257,9 +252,8 @@ question: messages are sent exactly as specified.

 
 
 
-
-
-packet() = #diameter_packet{}
+
+packet() = #diameter_packet{}
 
 

 A container for incoming and outgoing Diameter messages.
@@ -296,7 +290,7 @@ corresponding values.

 
 
 

-A record-valued msg field does not imply an absence of
+A record-valued msg field does not imply an absence of
 decode errors.
 The errors field should also be examined.

 
diff --git a/lib/diameter/doc/src/diameter_dict.xml b/lib/diameter/doc/src/diameter_dict.xml
index c924bd7fc3..9584d682c2 100644
--- a/lib/diameter/doc/src/diameter_dict.xml
+++ b/lib/diameter/doc/src/diameter_dict.xml
@@ -1,5 +1,5 @@
 
-FILE FORMAT'>
   
 
 
 
-
-
-@id Number
+
+@id Number
 
 

 Defines the integer Number as the Diameter Application Id of the
@@ -146,9 +145,8 @@ Example:

 
 
 
-
-
-@name Mod
+
+@name Mod
 
 

 Defines the name of the generated dictionary module.
@@ -169,9 +167,8 @@ Example:

 
 
 
-
-
-@prefix Name
+
+@prefix Name
 
 

 Defines Name as the prefix to be added to record and constant names
@@ -194,9 +191,8 @@ Example:

 
 
 
-
-
-@vendor Number Name
+
+@vendor Number Name
 
 

 Defines the integer Number as the the default Vendor-Id of AVPs for
@@ -216,9 +212,8 @@ Example:

 
 
 
-
-
-@avp_vendor_id Number
+
+@avp_vendor_id Number
 
 

 Defines the integer Number as the Vendor-Id of the AVPs listed in the
@@ -238,9 +233,8 @@ Region-Set
 
 
 
-
-
-@inherits Mod
+
+@inherits Mod
 
 

 Defines the name of a dictionary module containing AVP
@@ -274,9 +268,8 @@ Example:

 

 
 
-
-
-@avp_types
+
+@avp_types
 
 

 Defines the name, code, type and flags of individual AVPs.
@@ -308,9 +301,8 @@ The P flag has been deprecated by &the_rfc;.

 
 
 
-
-
-@custom_types Mod
+
+@custom_types Mod
 
 

 Specifies AVPs for which module Mod provides encode/decode functions.
@@ -331,9 +323,8 @@ Framed-IP-Address
 

 
 
-
-
-@codecs Mod
+
+@codecs Mod
 
 

 Like @custom_types but requires the specified module to export
@@ -350,9 +341,8 @@ Framed-IP-Address
- - -@messages + +@messages

Defines the messages of the application. @@ -397,9 +387,8 @@ RTA ::= < Diameter Header: 287, PXY > - - -@grouped + +@grouped

Defines the contents of the AVPs of the application having type @@ -424,9 +413,8 @@ Specifying a Vendor-Id in the definition of a grouped AVP is equivalent to specifying it with @avp_vendor_id.

 - - -@enum Name + +@enum Name

Defines values of AVP Name having type Enumerated. @@ -452,9 +440,8 @@ REMOVE_SIP_SERVER 3 - - -@end + +@end

Causes parsing of the dictionary to terminate: diff --git a/lib/diameter/doc/src/diameter_examples.xml b/lib/diameter/doc/src/diameter_examples.xml index 853ef96bb3..2e1f2b3c03 100644 --- a/lib/diameter/doc/src/diameter_examples.xml +++ b/lib/diameter/doc/src/diameter_examples.xml @@ -42,4 +42,3 @@ Example code can be found in the diameter application's examples subdirectory.

- diff --git a/lib/diameter/doc/src/diameter_transport.xml b/lib/diameter/doc/src/diameter_transport.xml index 736d4cbfbd..294e8a8864 100644 --- a/lib/diameter/doc/src/diameter_transport.xml +++ b/lib/diameter/doc/src/diameter_transport.xml @@ -65,9 +65,8 @@ parent).

- - -message() = binary() | &codec_packet; + +message() = binary() | &codec_packet;

A Diameter message as passed over the transport interface.

@@ -160,9 +159,9 @@ It should exit if its transport connection with its peer is lost.

-
+ MESSAGES

@@ -234,7 +233,7 @@ established a connection with the peer. Not sent if the transport process has Type=connect.

-{diameter, {self(), connected, Remote}} +{diameter, {self(), connected, Remote}} {diameter, {self(), connected, Remote, [LocalAddr]}}

diff --git a/lib/diameter/doc/src/diameterc.xml b/lib/diameter/doc/src/diameterc.xml index 5bffe9a771..8f1c660989 100644 --- a/lib/diameter/doc/src/diameterc.xml +++ b/lib/diameter/doc/src/diameterc.xml @@ -11,7 +11,7 @@

-20112013 +20112016 Ericsson AB. All Rights Reserved. @@ -79,14 +79,14 @@ Write generated source to the specified directory. Defaults to the current working directory.

- +

Suppress erl and hrl generation, respectively.

 -]]> +]]> ]]>

-- cgit v1.2.3