Skip to content

Commit 20cb92c

Browse files
committed
Add Link 4.1 Release Notes
1 parent 5f93522 commit 20cb92c

File tree

4 files changed

+46
-66
lines changed

4 files changed

+46
-66
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ Link enables the use of text files as the primary storage mechanism for APL sour
44
# Link Versions
55
Although Link is developed as a GitHub project and it is possible to fork or clone it and configure Dyalog APL to use it in this fashion, most users of Link will be using a version which is delivered via the Dyalog installer and updated using the Dyalog patch mechanism. Currently supported versions are:
66

7+
## Version 4.1 (Dyalog v20.0 - compatible with v19.0)
8+
Version 4.1 will be shipped with Dyalog 20.0 and is being tested with Dyalog v19.0.
9+
710
## Version 4.0 (Dyalog v19.0 - compatible with v18.2)
811
Version 4.0 was shipped with Dyalog 19.0 and works with version 18.2. The [online documentation](https://dyalog.github.io/link/) is maintained using markdown files which can be found in `docs` folder and deployed using `mkdocs` and `mike`, hosted with GitHub Pages.
912

docs/ReleaseNotes40.md

Lines changed: 0 additions & 65 deletions
This file was deleted.

docs/ReleaseNotes41.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Version 4.1 Release Notes
2+
3+
Link version 4.1 is distributed with Dyalog APL version 20.0 and is supported with version 19.0.
4+
You can select documentation for other versions of Link using the dropdown in the title bar.
5+
6+
Apart from these release notes and minor corrections to the documentation, the documentation for version 4.1
7+
is identical to 4.0. Version 4.1 is primarily a bug fix release. A couple of significant groups of
8+
fixes are discussed below,
9+
and the [version 4.1 milestone on GitHub](https://github.com/Dyalog/link/milestone/5?closed=1) documents the full
10+
set of issues that are resolved by version 4.1.
11+
12+
In addition to fixes, Link 4.1 recognises a new environment setting `ALWAYSREFORMAT`,
13+
which turns on automatic reformatting of all source code as it is written to source files.
14+
The following values are accepted:
15+
16+
* ALWAYSREFORMAT=0: Do not reformat the source code
17+
* ALWAYSREFORMAT=1: Reformat using standard tab settings (4), as returned by (`61 ⎕ATX`)
18+
* ALWAYSREFORMAT=2: Use user-configured tab settings, as returned by `⎕CR` or `⎕NR`.
19+
20+
## Significant fixes
21+
22+
### Improved Error Messages
23+
24+
Several error messages have been improved. For example, when a file
25+
cannot be imported to a classic interpreter due to a TRANSLATION ERROR,
26+
the file and the offending character is identified.
27+
28+
### Improved File System Watcher
29+
30+
The most significant improvement in version 4.1 is a complete rewrite of the code
31+
that handles file system watcher events, which increased the performance and the
32+
robustness of Link, when faced with several more or less simultaneous file updates.
33+
34+
For example, when using a source code management system like Git, a branch switch
35+
or a revert operation may cause a flurry of change to files. In Link 4.0, this
36+
could sometimes lead to functions disappearing, or failing to disappear when they should,
37+
as a result of processing messages in the wrong order.
38+
39+
Although Link 4.1 is very much more robust than Link 4.0 in this regard, it is still not
40+
recommended to copy or unzip hundreds or thousands of files with an active file system
41+
watcher.

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@ repo_name: Dyalog/Link
44
nav:
55
- Overview:
66
- index.md
7+
- ReleaseNotes41.md
78
- Discussion/TechDetails.md
89
- Discussion/Workspaces.md
910
- Discussion/History.md
1011

1112
- Install and Upgrade:
1213
- Usage/Installation.md
13-
- ReleaseNotes40.md
14+
- ReleaseNotes41.md
1415

1516
- Working with Link:
1617
- Usage/index.md

0 commit comments

Comments
 (0)