aboutsummaryrefslogtreecommitdiffstats
path: root/lib/diameter/doc/src/diameter_compile.xml
diff options
context:
space:
mode:
authorAnders Svensson <[email protected]>2011-10-21 10:43:05 +0200
committerAnders Svensson <[email protected]>2011-10-21 10:43:05 +0200
commit1cc659425002846f4f553add9d027ca620b42a22 (patch)
tree3ab5bfe885f993a941e1764d5d76be3146ad5e5a /lib/diameter/doc/src/diameter_compile.xml
parentaf5d050bd1d3595ff82353bec0ece6cd5690ffd9 (diff)
parenta0fb3d0302a18420cb622c9e172ca71ffdaf6a73 (diff)
downloadotp-1cc659425002846f4f553add9d027ca620b42a22.tar.gz
otp-1cc659425002846f4f553add9d027ca620b42a22.tar.bz2
otp-1cc659425002846f4f553add9d027ca620b42a22.zip
Merge branch 'anders/diameter/dictionaries/OTP-9641'
* anders/diameter/dictionaries/OTP-9641: Add diameter_make as compilation interface Update documentation Don't require -i directory to exist Allow @inherits to be set/cleared with diameterc Allow @name/@prefix to be set with diameterc Dependency fix Move dictionaries into own directory and rename Whitespace fixes @result_code -> @define in dictionary files
Diffstat (limited to 'lib/diameter/doc/src/diameter_compile.xml')
-rw-r--r--lib/diameter/doc/src/diameter_compile.xml32
1 files changed, 29 insertions, 3 deletions
diff --git a/lib/diameter/doc/src/diameter_compile.xml b/lib/diameter/doc/src/diameter_compile.xml
index 72bac30709..60e08d41da 100644
--- a/lib/diameter/doc/src/diameter_compile.xml
+++ b/lib/diameter/doc/src/diameter_compile.xml
@@ -64,9 +64,10 @@ Defaults to the current working directory.</p>
<item>
<p>
Specifies a directory to add to the code path.
-Typically used to point at beam files corresponding to dictionaries
-included by the one being compiled (using the <c>@includes</c> directive):
-inclusion is a beam dependency, not an erl/hrl dependency.</p>
+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>
<p>
Multiple <c>-i</c> options can be specified.</p>
@@ -84,6 +85,31 @@ Supresses erl generation.</p>
Supresses hrl generation.</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.
+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>
+
+<p>
+Multiple <c>--inherits</c> options can be specified.</p>
+</item>
+
</taglist>
</item>