Skip to content

Commit 9a6ce6f

Browse files
committed
Document -preloaded and Link.Create ignoring locals
1 parent ae91fe7 commit 9a6ce6f

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

docs/API/Link.Create.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Link.Create
22

33
## Syntax
4-
]LINK.Create [ns] <dirorfile> [-source={ns|dir|auto}] [-watch={none|ns|dir|both}] [-casecode] [-forceextensions] [-forcefilenames] [-arrays] [-sysvars] [-flatten] [-beforeread=<fn>] [-beforewrite=<fn>] [-getfilename=<fn>] [-codeextensions=<var>] [-typeextensions=<var>] [-fastload] [-ignoreconfig] [-text={aplan|plain}]
4+
]LINK.Create [ns] <dirorfile> [-source={ns|dir|auto}] [-watch={none|ns|dir|both}] [-casecode] [-forceextensions] [-forcefilenames] [-arrays] [-sysvars] [-flatten] [-preloaded] [-beforeread=<fn>] [-beforewrite=<fn>] [-getfilename=<fn>] [-codeextensions=<var>] [-typeextensions=<var>] [-fastload] [-ignoreconfig] [-text={aplan|plain}]
55

66
message ← {options} ⎕SE.Link.Create (namespace directory)
77

@@ -113,6 +113,14 @@ A suggested workflow is to always create a stub source file in the correct direc
113113

114114
This option takes effect only when **source** is **dir**.
115115

116+
### **preloaded**
117+
Default: **off**
118+
119+
The **preloaded** flag skips the reading of source files when creating
120+
links. This is useful if you have loaded a saved workspace which is known
121+
to contain the latest version of the source, or have materialised the
122+
source using other mechanisms such as shared code files.
123+
116124
### **caseCode**
117125

118126
Default: **off**

docs/ReleaseNotes41.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ fixes are discussed below,
99
and the [version 4.1 milestone on GitHub](https://github.com/Dyalog/link/milestone/5?closed=1) documents the full
1010
set of issues that are resolved by version 4.1.
1111

12+
## Control Reformatting
13+
1214
In addition to fixes, Link 4.1 recognises a new environment setting `ALWAYSREFORMAT`,
1315
which turns on automatic reformatting of all source code as it is written to source files.
1416
The following values are accepted:
@@ -17,6 +19,20 @@ The following values are accepted:
1719
* ALWAYSREFORMAT=1: Reformat using standard tab settings (4), as returned by (`61 ⎕ATX`)
1820
* ALWAYSREFORMAT=2: Use user-configured tab settings, as returned by `⎕CR` or `⎕NR`.
1921

22+
## Link.Create ignores local names
23+
24+
`Link.Create` ignores local names in calling functions when determining whether the target namespace
25+
is empty. This makes it much easier to write functions that load code into a workspace at the
26+
start of an application.
27+
28+
## Link.Create -preloaded Allows Optimised Development Environments
29+
30+
If an application uses thousands (or tens of thousands) of source files, `Link.Create` can take a
31+
a significant amount of time. The `-preloaded` switch allows you to build a development workspace
32+
using `Link.Create`, and save this workspace or export the contents a shared code file. At the start
33+
of a development session, you can call `Link.Create` with the `-preloaded` switch, which will
34+
re-establish all metadata related to the link, but skip loading the source code.
35+
2036
## Significant fixes
2137

2238
### Improved Error Messages

0 commit comments

Comments
 (0)