aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/doc
diff options
context:
space:
mode:
authorHans Bolinder <[email protected]>2018-01-15 12:37:18 +0100
committerHans Bolinder <[email protected]>2018-01-15 12:37:18 +0100
commit43902ae7e7c03f174e4f1c2620f9d1b73a56ec65 (patch)
treeba168340f2cc55644bd67bf56f4482bee6b4dac0 /lib/kernel/doc
parent030070142f4128213ac1052319d19ad1926996b3 (diff)
parent39dbc655f6aa2a971019feccefa3a27273305091 (diff)
downloadotp-43902ae7e7c03f174e4f1c2620f9d1b73a56ec65.tar.gz
otp-43902ae7e7c03f174e4f1c2620f9d1b73a56ec65.tar.bz2
otp-43902ae7e7c03f174e4f1c2620f9d1b73a56ec65.zip
Merge branch 'maint'
* maint: stdlib: Correct a filelib test case stdlib: Let filelib:find_source() search subdirs
Diffstat (limited to 'lib/kernel/doc')
-rw-r--r--lib/kernel/doc/src/kernel_app.xml20
1 files changed, 17 insertions, 3 deletions
diff --git a/lib/kernel/doc/src/kernel_app.xml b/lib/kernel/doc/src/kernel_app.xml
index e5ac031539..0762cebc94 100644
--- a/lib/kernel/doc/src/kernel_app.xml
+++ b/lib/kernel/doc/src/kernel_app.xml
@@ -4,7 +4,7 @@
<appref>
<header>
<copyright>
- <year>1996</year><year>2017</year>
+ <year>1996</year><year>2018</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -469,8 +469,12 @@ MaxT = TickTime + TickTime / 4</code>
<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
+ <p>Specifies a list of rules for use by
+ <seealso marker="stdlib:filelib#find_file/2">
+ <c>filelib:find_file/2</c></seealso>
+ <seealso marker="stdlib:filelib#find_source/2">
+ <c>filelib:find_source/2</c></seealso>
+ 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
@@ -478,6 +482,16 @@ MaxT = TickTime + TickTime / 4</code>
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>
+ <p>The interpretation of <c>ObjDirSuffix</c> and <c>SrcDirSuffix</c>
+ is as follows: if the end of the directory name where an
+ object is located matches <c>ObjDirSuffix</c>, then the
+ name created by replacing <c>ObjDirSuffix</c> with
+ <c>SrcDirSuffix</c> is expanded by calling
+ <seealso marker="stdlib:filelib#wildcard/1">
+ <c>filelib:wildcard/1</c></seealso>, and the first regular
+ file found among the matches is the source file.
+ </p>
+
</item>
</taglist>
</section>