From 9f0819a3582e128a9ef88d6dd79801ecaabcf0f8 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Sat, 23 Mar 2013 19:05:39 +0100 Subject: Documentation fixes Fix errors and omissions related to dictionary compilation. --- lib/diameter/doc/src/diameter_compile.xml | 32 ++++++++++++++++++-------- lib/diameter/doc/src/diameter_dict.xml | 5 ++-- lib/diameter/doc/src/diameter_make.xml | 38 +++++++++++++++++++++---------- 3 files changed, 50 insertions(+), 25 deletions(-) (limited to 'lib') diff --git a/lib/diameter/doc/src/diameter_compile.xml b/lib/diameter/doc/src/diameter_compile.xml index 0bd7ad1789..fc81e4efed 100644 --- a/lib/diameter/doc/src/diameter_compile.xml +++ b/lib/diameter/doc/src/diameter_compile.xml @@ -11,7 +11,7 @@
-20112012 +20112013 Ericsson AB. All Rights Reserved. @@ -59,6 +59,7 @@ The module &man_make; provides an alternate compilation interface.

Compile a single dictionary file to Erlang source. Valid options are as follows.

+ ]]>

@@ -71,7 +72,6 @@ dependency, not an erl/hrl dependency.

Multiple -i options can be specified.

- ]]>

@@ -90,18 +90,30 @@ Supress erl and hrl generation, respectively.

]]>

-Set &dict_name; or &dict_prefix; to the specified -string. -Overrides any setting in the file itself.

+Transform the input dictionary before compilation, setting +&dict_name; or &dict_prefix; to the specified +string.

-]]> +]]>

-Append &dict_inherits; of the specified module. -Specifying "-" has the effect of discarding clearing any -previous inherits, both in the dictionary file and on the options -list.

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

diff --git a/lib/diameter/doc/src/diameter_dict.xml b/lib/diameter/doc/src/diameter_dict.xml index 1034781ff2..419dc143af 100644 --- a/lib/diameter/doc/src/diameter_dict.xml +++ b/lib/diameter/doc/src/diameter_dict.xml @@ -263,15 +263,14 @@ dictionary's definitions but the former makes for easier reuse.

All dictionaries should typically inherit &the_rfc; AVPs from -diameter_gen_base_rfc3588.

+diameter_gen_base_rfc6733.

Example:

-@inherits diameter_gen_base_rfc3588
+@inherits diameter_gen_base_rfc6733
 
-
diff --git a/lib/diameter/doc/src/diameter_make.xml b/lib/diameter/doc/src/diameter_make.xml index da6124310e..ec71251be1 100644 --- a/lib/diameter/doc/src/diameter_make.xml +++ b/lib/diameter/doc/src/diameter_make.xml @@ -14,6 +14,7 @@
2012 +2013 Ericsson AB. All Rights Reserved. @@ -73,7 +74,7 @@ Compile a single dictionary file to Erlang source. -{include, Dir::string()} +{include, string()}

Prepend the specified directory to the code path. @@ -85,7 +86,7 @@ dependency, not an erl/hrl dependency.

Multiple include options can be specified.

-{outdir, Dir::string()} +{outdir, string()}

Write generated source to the specified directory. @@ -95,18 +96,30 @@ Defaults to the current working directory.

{name|prefix, string()}

-Set &dict_name; or &dict_prefix; to the specified -string. -Overrides any setting in the file itself.

+Transform the input dictionary before compilation, setting +&dict_name; or &dict_prefix; to the specified +string.

-{inherits, Mod::string()} +{inherits, string()}

-Append &dict_inherits; of the specified module. -Specifying "-" has the effect of discarding clearing any -previous inherits, both in the dictionary file and on the options -list.

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

@@ -126,8 +139,9 @@ Multiple inherits options can be specified.

All options are string-valued. -In particular, it is not currently possible to -an &dict_inherits; module as an atom() or a path as a &filename;

+In particular, it is not currently possible to specify +an &dict_inherits; module as an atom(), or a path as an arbitrary +&filename;

-- cgit v1.2.3