diff options
| author | Siri Hansen <[email protected]> | 2016-09-29 10:51:58 +0200 |
|---|---|---|
| committer | Siri Hansen <[email protected]> | 2016-09-29 10:51:58 +0200 |
| commit | b1c1bea9242c5b44f17c5f8aca40c9d0eedf0756 (patch) | |
| tree | fdfbd9fbfd6cba6fd6d47b7bfcfee1031d8e5f2d | |
| parent | 8bde09c998c68265361155aa8ed188aa0e2a4a44 (diff) | |
| parent | 714570912d678c10f4aa4b6a6692d958e0fc7fe7 (diff) | |
| download | otp-b1c1bea9242c5b44f17c5f8aca40c9d0eedf0756.tar.gz otp-b1c1bea9242c5b44f17c5f8aca40c9d0eedf0756.tar.bz2 otp-b1c1bea9242c5b44f17c5f8aca40c9d0eedf0756.zip | |
Merge branch 'siri/doc-add_pathsa-order/ERL-267/OTP-13920' into maint
* siri/doc-add_pathsa-order/ERL-267/OTP-13920:
Document the order of directories added with code:add_pathsa/1
| -rw-r--r-- | erts/doc/src/erl.xml | 8 | ||||
| -rw-r--r-- | lib/kernel/doc/src/code.xml | 11 | ||||
| -rw-r--r-- | lib/sasl/doc/src/script.xml | 2 |
3 files changed, 14 insertions, 7 deletions
diff --git a/erts/doc/src/erl.xml b/erts/doc/src/erl.xml index f62d3fb170..eb1d24cf12 100644 --- a/erts/doc/src/erl.xml +++ b/erts/doc/src/erl.xml @@ -393,9 +393,11 @@ <tag><c><![CDATA[-pa Dir1 Dir2 ...]]></c></tag> <item> <p>Adds the specified directories to the beginning of the code - path, similar to <c><![CDATA[code:add_pathsa/1]]></c>; see - <seealso marker="kernel:code"><c>code(3)</c></seealso>. - As an alternative to <c>-pa</c>, if several directories are + path, similar to <seealso marker="kernel:code#add_pathsa/1"> + <c><![CDATA[code:add_pathsa/1]]></c></seealso>. Note that the + order of the given directories will be reversed in the + resulting path.</p> + <p>As an alternative to <c>-pa</c>, if several directories are to be prepended to the code path and the directories have a common parent directory, that parent directory can be specified in environment variable <c>ERL_LIBS</c>; see diff --git a/lib/kernel/doc/src/code.xml b/lib/kernel/doc/src/code.xml index 4db377bcde..3143cdc825 100644 --- a/lib/kernel/doc/src/code.xml +++ b/lib/kernel/doc/src/code.xml @@ -382,9 +382,14 @@ zip:create("mnesia-4.4.7.ez", <name name="add_pathsa" arity="1"/> <fsummary>Add directories to the beginning of the code path.</fsummary> <desc> - <p>Adds the directories in <c><anno>Dirs</anno></c> to the beginning of - the code path. If a <c><anno>Dir</anno></c> exists, it is removed - from the old position in the code path.</p> + <p>Traverses <c><anno>Dirs</anno></c> and adds + each <c><anno>Dir</anno></c> to the beginning of the code + path. This means that the order of <c><anno>Dirs</anno></c> + is reversed in the resulting code path. For example, if you + add <c>[Dir1,Dir2]</c>, the resulting path will + be <c>[Dir2,Dir1|OldCodePath]</c>.</p> + <p>If a <c><anno>Dir</anno></c> already exists in the code + path, it is removed from the old position.</p> <p>Always returns <c>ok</c>, regardless of the validity of each individual <c><anno>Dir</anno></c>.</p> </desc> diff --git a/lib/sasl/doc/src/script.xml b/lib/sasl/doc/src/script.xml index 8ed132354d..b40ff28179 100644 --- a/lib/sasl/doc/src/script.xml +++ b/lib/sasl/doc/src/script.xml @@ -88,7 +88,7 @@ follows:</p> <list type="bulleted"> <item><c>-pa Dir1 Dir2 ... DirN</c> adds the directories - <c>Dir1, Dir2, ..., DirN</c> to the front of the initial + <c>DirN, DirN-1, ..., Dir2, Dir1</c> to the front of the initial load path.</item> <item><c>-pz Dir1 Dir2 ... DirN</c> adds the directories <c>Dir1, Dir2, ..., DirN</c> to the end of the initial |