Skip to content

Commit 2915438

Browse files
Fix typos in System Principles
Co-authored-by: Maria Scott <maria-12648430@hnc-agency.org>
1 parent 5c44cb6 commit 2915438

5 files changed

Lines changed: 22 additions & 22 deletions

File tree

system/doc/system_principles/create_target.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ functionality:
4545
script.
4646
- A _simple target system_ that also supports code replacement in runtime.
4747
- An _embedded target system_ that also supports starting automatically
48-
at boot time, and logging output from the system files for later inspection.
48+
at boot time, and logging output from the system to files for later inspection.
4949

5050
Here is only considered the case when Erlang/OTP is running on a UNIX system.
5151

@@ -122,7 +122,7 @@ lib/sasl-2.3.4/
122122
lib/pea-1.0/
123123
```
124124

125-
The file `releases/FIRST/start.boot` is a copy of our `mysystem.boot`
125+
The file `releases/FIRST/start.boot` is a copy of our `mysystem.boot`.
126126

127127
The release resource file `mysystem.rel` is duplicated in the tar file.
128128
Originally, this file was only stored in the `releases` directory to make it
@@ -204,7 +204,7 @@ script calls `bin/run_erl`, which in turn calls `bin/start_erl` (roughly,
204204
`start_erl` is an embedded variant of `erl`).
205205

206206
The shell script `start`, which is generated from `erts-5.10.4/bin/start.src`
207-
during installation, is merely an example. Edit it to suite your needs. Typically
207+
during installation, is merely an example. Edit it to suit your needs. Typically
208208
it is executed when the UNIX system boots.
209209

210210
`run_erl` is a wrapper that provides logging of output from the runtime system
@@ -214,7 +214,7 @@ to file. It also provides a simple mechanism for attaching to the Erlang shell
214214
`start_erl` requires:
215215

216216
1. The root directory (`"/usr/local/erl-target"`)
217-
1. The releases directory (`"/usr/local/erl-target/releases"`
217+
1. The releases directory (`"/usr/local/erl-target/releases"`)
218218
1. The location of the file `start_erl.data`
219219

220220
It performs the following:
@@ -225,7 +225,7 @@ It performs the following:
225225
1. Provides the flag `-boot` specifying the boot file of the release version
226226
found (`"releases/FIRST/start.boot"`).
227227

228-
`start_erl` also assumes that there is `sys.config` in the release version
228+
`start_erl` also assumes that there is a `sys.config` in the release version
229229
directory (`"releases/FIRST/sys.config"`). That is the topic of the next
230230
section.
231231

@@ -244,7 +244,7 @@ In fact, if you in the current directory create not only the file
244244
`mysystem.rel`, but also file `sys.config`, the latter file is tacitly put in
245245
the appropriate directory.
246246

247-
However, it can also be convenient to replace variables in within a `sys.config`
247+
However, it can also be convenient to replace variables within a `sys.config`
248248
on the target after unpacking but before running the release. If you have a
249249
`sys.config.src` it will be included and is not required to be a valid Erlang
250250
term file like `sys.config`. Before running the release you must have a valid
@@ -256,12 +256,12 @@ booting the release.
256256

257257
The previous `install/2` procedure differs somewhat from that of the ordinary
258258
`Install` shell script. In fact, `create/1` makes the release package as
259-
complete as possible, and leave to the `install/2` procedure to finish by only
259+
complete as possible, and leaves it to the `install/2` procedure to finish by only
260260
considering location-dependent files.
261261

262262
## Creating the Next Version
263263

264-
In this example the Pea application has been changed, and so are the
264+
In this example the Pea application has been changed, and so have the
265265
applications ERTS, Kernel, STDLIB and SASL.
266266

267267
_Step 1._ Create the file `.rel`:
@@ -371,7 +371,7 @@ It can be accessed as follows:
371371
```
372372

373373
Logs can be found in `/usr/local/erl-target/log`. This directory is specified as
374-
an argument to `run_erl`in the start script listed above.
374+
an argument to `run_erl` in the start script listed above.
375375

376376
_Step 1._ Unpack the release:
377377

@@ -425,7 +425,7 @@ _Step 3._ Make the new release permanent:
425425

426426
Check the releases again:
427427

428-
```c
428+
```erlang
429429
3> release_handler:which_releases().
430430
[{"MYSYSTEM","SECOND",
431431
["kernel-3.0","stdlib-2.0","sasl-2.4","pea-2.0"],

system/doc/system_principles/error_logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ compatibility, be enabled by setting the Kernel configuration parameter
6262
`true`. For more information, see
6363
[SASL Error Logging](`e:sasl:error_logging.md`) in the SASL User's Guide.
6464

65-
```erlang
65+
```text
6666
% erl -kernel logger_level info
6767
Erlang/OTP 21 [erts-10.0] [source-13c50db] [64-bit] [smp:4:4] [ds:4:4:10] [async-threads:1] [hipe]
6868

system/doc/system_principles/misc.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Pull requests are only accepted on the `maint` and the `master`
4545
branches in our [git repository](https://github.com/erlang/otp). The
4646
`maint` branch contains changes planned for the next [maintenance
4747
patch package](versions.md#releases_and_patches) on the latest OTP
48-
release and the `master` branch contain changes planned for the
48+
release and the `master` branch contains changes planned for the
4949
upcoming OTP release.
5050

5151
## Compatibility
@@ -61,7 +61,7 @@ are handled.
6161
preceding and two subsequent releases.
6262

6363
- **Compiled BEAM Code, NIF Libraries, and Drivers** - Compiled code
64-
can be loaded on at least two subsequent releases. To achive the
64+
can be loaded on at least two subsequent releases. To achieve the
6565
highest possible performance for Erlang code, ensure it is compiled
6666
using the same release as the one it will be deployed on.
6767

@@ -111,7 +111,7 @@ functionality unless an upcoming removal is explicitly stated in the
111111
deprecation notice.
112112

113113
Deprecated functionality will be documented as deprecated and highlighted
114-
in a release note as early possible. If appropriate, the compiler will
114+
in a release note as early as possible. If appropriate, the compiler will
115115
issue warnings when the deprecated functionality is used.
116116

117117
There is a page in the documentation regarding deprecations:
@@ -133,7 +133,7 @@ functionality in the language itself and core libraries used during operation.
133133
There are two pages in the documentation regarding removal:
134134

135135
* [Scheduled for Removal](`e:general_info:scheduled_for_removal.md`) - lists
136-
all functionality that is schedule for removal in upcoming releases.
136+
all functionality that is scheduled for removal in upcoming releases.
137137

138138
* [Removed Functionality](`e:general_info:removed.md`) - lists
139139
functionality that has been removed.

system/doc/system_principles/system_principles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ For more information about `.rel` files, see
143143
[Release Handling](`e:system:release_handling.md`) and the
144144
[rel](`e:sasl:rel.md`) page in SASL.
145145

146-
To generate the binary boot script file `Name.boot` the boot script file
146+
To generate the binary boot script file `Name.boot` from the boot script file
147147
`Name.script`, use the
148148
[`systools:script2boot(File)`](https://www.erlang.org/doc/man/systools#script2boot-1)
149149
function.

system/doc/system_principles/versions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ version scheme used is described in detail in
3131
[Version Scheme](versions.md#version_scheme).
3232

3333
OTP of a specific version is a set of applications of specific versions. The
34-
application versions identified by an OTP version corresponds to application
34+
application versions identified by an OTP version correspond to application
3535
versions that have been tested together by the Erlang/OTP team at Ericsson AB.
3636
An OTP system can, however, be put together with applications from different OTP
3737
versions. Such a combination of application versions has not been tested by the
@@ -50,7 +50,7 @@ constructed by calling
5050

5151
In an installed OTP development system, the OTP version can be read from the
5252
text file `<OTP installation root>/releases/<OTP release number>/OTP_VERSION`.
53-
The absolute path to the file can by constructed by calling
53+
The absolute path to the file can be constructed by calling
5454
`filename:join([`[`code:root_dir()`](`code:root_dir/0`)`, "releases", `[`erlang:system_info(otp_release)`](`m:erlang#system_info_otp_release`)`, "OTP_VERSION"]).`
5555

5656
If the version read from the `OTP_VERSION` file in a development system has a
@@ -82,7 +82,7 @@ that are part of a specific OTP version, and has the following format:
8282
to identify the source.
8383

8484
`<ChangedAppVersions>` and `<UnchangedAppVersions>` are space-separated lists of
85-
application versions and has the format `<application>-<vsn>`.
85+
application versions and have the format `<application>-<vsn>`.
8686

8787
- `<ChangedAppVersions>` corresponds to changed applications with new version
8888
numbers in this OTP version.
@@ -134,7 +134,7 @@ Normally, a version is constructed as `<Major>.<Minor>.<Patch>`, where
134134
dot-separated parts are possible.
135135

136136
The dot-separated parts consist of non-negative integers. If all parts
137-
less significant than `<Minor>` equals `0`, they are omitted. The
137+
less significant than `<Minor>` equal `0`, they are omitted. The
138138
three normal parts `<Major>.<Minor>.<Patch>` are changed as follows:
139139

140140
- `<Major>` - Increases when major changes, including incompatibilities, are
@@ -198,9 +198,9 @@ usually contain more changes than emergency patch packages. Emergency patch
198198
packages are released to solve one or more specific issues when such are
199199
discovered.
200200

201-
The release of a maintenance patch package usually imply an increase
201+
The release of a maintenance patch package usually implies an increase
202202
of the OTP `<Minor>` version, while the release of an emergency patch
203-
package usually imply an increase of the OTP `<Patch>`
203+
package usually implies an increase of the OTP `<Patch>`
204204
version. However, this is not always the case, as changes in OTP
205205
versions are determined by actual code modifications rather than
206206
whether the patch was planned or not. For more information see

0 commit comments

Comments
 (0)