diff options
author | Anders Svensson <[email protected]> | 2012-08-30 13:14:16 +0200 |
---|---|---|
committer | Anders Svensson <[email protected]> | 2012-08-30 13:14:16 +0200 |
commit | 6de88765e9e3275e2b52dd25a1e6bc8e4df8486b (patch) | |
tree | 68cf39263919f62e5c99d1ba5444b169c3332238 /lib/diameter/doc/src/diameter_compile.xml | |
parent | e82402b8f6cd0e8f0a1d9ae60555e333f6e0fb48 (diff) | |
parent | 910055a9257ae0bd5c9203fccc2eb13d07c6dc21 (diff) | |
download | otp-6de88765e9e3275e2b52dd25a1e6bc8e4df8486b.tar.gz otp-6de88765e9e3275e2b52dd25a1e6bc8e4df8486b.tar.bz2 otp-6de88765e9e3275e2b52dd25a1e6bc8e4df8486b.zip |
Merge branch 'anders/diameter/documentation/OTP-10216' into maint
* anders/diameter/documentation/OTP-10216:
Fix broken references
Correct doc on AVP P flag and add warning about its deprecation
Fix/tweak references to other applications
Minor formatting fixes
Add warning about 'host' filter
Update diameterc doc
Minor updates/corrections to Users Guide
Add SCTP warning, more references
Assorted doc improvements
Document service info
Document watchdog events
Terminology and other clarifications, more references
Clarify documentation on application state
Diffstat (limited to 'lib/diameter/doc/src/diameter_compile.xml')
-rw-r--r-- | lib/diameter/doc/src/diameter_compile.xml | 45 |
1 files changed, 12 insertions, 33 deletions
diff --git a/lib/diameter/doc/src/diameter_compile.xml b/lib/diameter/doc/src/diameter_compile.xml index 60e08d41da..7a6ca48798 100644 --- a/lib/diameter/doc/src/diameter_compile.xml +++ b/lib/diameter/doc/src/diameter_compile.xml @@ -4,7 +4,7 @@ <comref> <header> <copyright> -<year>2011</year> +<year>2011</year><year>2012</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -31,7 +31,7 @@ supplied. <description> <p> -The diameterc utility is used to transform diameter +The diameterc utility is used to compile diameter <seealso marker="diameter_dict">dictionary files</seealso> into Erlang source. The resulting source implements the interface diameter requires @@ -47,7 +47,7 @@ to encode and decode the dictionary's messages and AVP's.</p> <tag><![CDATA[diameterc [<options>] <file>]]></tag> <item> <p> -Transforms a single dictionary file. Valid options are as follows.</p> +Compiles a single dictionary file. Valid options are as follows.</p> <!-- Leave -h/d/v undocumented, except for the usage message from the utility itself. --> @@ -64,47 +64,36 @@ Defaults to the current working directory.</p> <item> <p> Specifies a directory to add to the code path. -Use to point at beam files corresponding to dictionaries -inherited by the one being compiled using <c>@inherits</c> or -<c>--inherits</c>. -Inheritance is a beam dependency, not an erl/hrl dependency.</p> +Use to point at beam files compiled from inherited dictionaries, +<c>@inherits</c> in a dictionary file creating a beam dependency, not +an erl/hrl dependency.</p> <p> Multiple <c>-i</c> options can be specified.</p> </item> <tag><![CDATA[-E]]></tag> -<item> -<p> -Supresses erl generation.</p> -</item> - <tag><![CDATA[-H]]></tag> <item> <p> -Supresses hrl generation.</p> +Supresses erl and hrl generation, respectively.</p> </item> <tag><![CDATA[--name <name>]]></tag> -<item> -<p> -Set <c>@name</c> in the dictionary file. -Overrides any setting in the file itself.</p> -</item> - <tag><![CDATA[--prefix <prefix>]]></tag> <item> <p> -Set <c>@prefix</c> in the dictionary file. +Set <c>@name</c> and <c>@prefix</c> in the dictionary, +respectively. Overrides any setting in the file itself.</p> </item> <tag><![CDATA[--inherits <dict>]]></tag> <item> <p> -Append an <c>@inherits</c> to the dictionary file. -Specifying <c>'-'</c> as the dictionary has the effect of clearing -any previous inherits, effectively ignoring previous inherits.</p> +Append an <c>@inherits</c> to the dictionary before compiling. +Specifying <c>'-'</c> as the dictionary has the effect of clearing any +previous inherits, causing them to be ignored.</p> <p> Multiple <c>--inherits</c> options can be specified.</p> @@ -130,16 +119,6 @@ Returns 0 on success, non-zero on failure.</p> <!-- ===================================================================== --> <section> -<title>BUGS</title> - -<p> -The identification of errors in the source file is poor.</p> - -</section> - -<!-- ===================================================================== --> - -<section> <title>SEE ALSO</title> <p> |