aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/doc
diff options
context:
space:
mode:
authorRichard Carlsson <[email protected]>2017-01-19 17:11:19 +0100
committerRichard Carlsson <[email protected]>2017-02-06 15:36:20 +0100
commiteab4b024957a27be018f8bc155bdd1dc05ec7969 (patch)
treebc384ec9852b4a64058a0ab451b035daf0f2c2f8 /lib/kernel/doc
parent57aaf7d0c7c75cfd8c6b55c21d977b695f460022 (diff)
downloadotp-eab4b024957a27be018f8bc155bdd1dc05ec7969.tar.gz
otp-eab4b024957a27be018f8bc155bdd1dc05ec7969.tar.bz2
otp-eab4b024957a27be018f8bc155bdd1dc05ec7969.zip
Document the kernel source_search_rules parameter
Diffstat (limited to 'lib/kernel/doc')
-rw-r--r--lib/kernel/doc/src/kernel_app.xml22
1 files changed, 22 insertions, 0 deletions
diff --git a/lib/kernel/doc/src/kernel_app.xml b/lib/kernel/doc/src/kernel_app.xml
index df681a505f..0db3aa50c5 100644
--- a/lib/kernel/doc/src/kernel_app.xml
+++ b/lib/kernel/doc/src/kernel_app.xml
@@ -379,6 +379,28 @@ MaxT = TickTime + TickTime / 4</code>
return as soon as possible for <c>application_controller</c>
to terminate properly.</p>
</item>
+ <tag><c>source_search_rules = [DirRule] | [SuffixRule] </c></tag>
+ <item>
+ <marker id="source_search_rules"></marker>
+ <p>Where:</p>
+ <list type="bulleted">
+ <item><c>DirRule = {ObjDirSuffix,SrcDirSuffix}</c></item>
+ <item><c>SuffixRule = {ObjSuffix,SrcSuffix,[DirRule]}</c></item>
+ <item><c>ObjDirSuffix = string()</c></item>
+ <item><c>SrcDirSuffix = string()</c></item>
+ <item><c>ObjSuffix = string()</c></item>
+ <item><c>SrcSuffix = string()</c></item>
+ </list>
+ <p>Specifies a list of rules for use by <c>filelib:find_file/2</c> and
+ <c>filelib:find_source/2</c>. If this is set to some other value
+ than the empty list, it replaces the default rules. Rules can be
+ simple pairs of directory suffixes, such as <c>{"ebin",
+ "src"}</c>, which are used by <c>filelib:find_file/2</c>, or
+ triples specifying separate directory suffix rules depending on
+ file name extensions, for example <c>[{".beam", ".erl", [{"ebin",
+ "src"}]}</c>, which are used by <c>filelib:find_source/2</c>. Both
+ kinds of rules can be mixed in the list.</p>
+ </item>
</taglist>
</section>