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 /lib/kernel | |
| 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
Diffstat (limited to 'lib/kernel')
| -rw-r--r-- | lib/kernel/doc/src/code.xml | 11 |
1 files changed, 8 insertions, 3 deletions
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> |