File 2334-Document-the-kernel-source_search_rules-pa... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2334-Document-the-kernel-source_search_rules-parameter.patch of Package erlang (Revision 865d2e25c8b9e0a1b23f89d693ffd991)

Currently displaying revision 865d2e25c8b9e0a1b23f89d693ffd991 , Show latest

From eab4b024957a27be018f8bc155bdd1dc05ec7969 Mon Sep 17 00:00:00 2001
From: Richard Carlsson <richardc@klarna.com>
Date: Thu, 19 Jan 2017 17:11:19 +0100
Subject: [PATCH 4/8] Document the kernel source_search_rules parameter

---
 lib/kernel/doc/src/kernel_app.xml | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/lib/kernel/doc/src/kernel_app.xml b/lib/kernel/doc/src/kernel_app.xml
index df681a505..0db3aa50c 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.
 </item>
+ <tag><c>source_search_rules = [DirRule] | [SuffixRule] </c></tag>
+ <item>
+	<marker id="source_search_rules"></marker>
+ Where:
+ <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>
+ 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.
+ </item>
 </taglist>
 </section>
 
-- 
2.11.1

Places

File 2334-Document-the-kernel-source_search_rules-parameter.patch of Package erlang (Revision 865d2e25c8b9e0a1b23f89d693ffd991)

Places