aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRickard Green <[email protected]>2014-03-21 14:37:18 +0100
committerRickard Green <[email protected]>2014-03-21 14:37:18 +0100
commit78ad5368f520c5fa6400d4f16909b23fe5225255 (patch)
tree80fa08785954c031c985557e9179a62c10de8a5d
parentb9138aac8f0a07f210cf639f6fc185996c50c810 (diff)
parent4548d750deecbf2ebefa4f769165c55d0169017a (diff)
downloadotp-78ad5368f520c5fa6400d4f16909b23fe5225255.tar.gz
otp-78ad5368f520c5fa6400d4f16909b23fe5225255.tar.bz2
otp-78ad5368f520c5fa6400d4f16909b23fe5225255.zip
Merge branch 'rickard/runtime-dep/OTP-11773'
* rickard/runtime-dep/OTP-11773: Documentation fix
-rw-r--r--lib/kernel/doc/src/app.xml4
-rw-r--r--system/doc/system_principles/versions.xml19
2 files changed, 12 insertions, 11 deletions
diff --git a/lib/kernel/doc/src/app.xml b/lib/kernel/doc/src/app.xml
index b24a2bd7bd..8575d94048 100644
--- a/lib/kernel/doc/src/app.xml
+++ b/lib/kernel/doc/src/app.xml
@@ -213,8 +213,8 @@ RTDeps [ApplicationVersion] []
OTP 17.0. The type of its value might be subject to changes during
the OTP 17 release.</p></warning>
<warning><p>All runtime dependencies specified in OTP applications
- during the OTP 17 release might not be completely correct. This
- is actively worked on. Declared runtime dependencies in OTP
+ during the OTP 17 release may not be completely correct. This
+ is actively being worked on. Declared runtime dependencies in OTP
applications are expected to be correct in OTP 18.</p></warning>
</item>
</taglist>
diff --git a/system/doc/system_principles/versions.xml b/system/doc/system_principles/versions.xml
index 6bfa9d1eed..2bf0d18010 100644
--- a/system/doc/system_principles/versions.xml
+++ b/system/doc/system_principles/versions.xml
@@ -79,18 +79,18 @@
</section>
<section><title>OTP Versions Table</title>
- <p>The text file <c>&lt;OTP source root&gt;/otp_versions.table</c>
- part of the source code contains information about all OTP versions
+ <p>The text file <c>&lt;OTP source root&gt;/otp_versions.table</c> that
+ is part of the source code contains information about all OTP versions
from OTP 17.0 up to current OTP version. Each line contains information
- about application versions part of a specific OTP version, and is on
- the format:</p>
+ about application versions that are part of a specific OTP version, and
+ is on the format:</p>
<pre>
-&lt;OtpVersion&gt; : &lt;ChangedAppVersions&gt; # &lt;UnchangedAppVersions&gt;
+&lt;OtpVersion&gt; : &lt;ChangedAppVersions&gt; # &lt;UnchangedAppVersions&gt; :
</pre>
<p><c>&lt;OtpVersion&gt;</c> is on the format <c>OTP-&lt;VSN&gt;</c>, i.e.,
the same as the git tag used to identify the source.
<c>&lt;ChangedAppVersions&gt;</c> and <c>&lt;UnchangedAppVersions&gt;</c>
- are white space separated lists of application versions on the
+ are space separated lists of application versions on the
format <c>&lt;application&gt;-&lt;vsn&gt;</c>.
<c>&lt;ChangedAppVersions&gt;</c> corresponds to changed applications
with new version numbers in this OTP version, and
@@ -99,14 +99,15 @@
not at the same time. If &lt;ChangedAppVersions&gt; is empty, no changes
has been made that change the build result of any application. This could
for example be a pure bug fix of the build system. The order of lines
- is undefined.</p>
+ is undefined. All white space characters in this file are either space
+ (character 32) or line-break (character 10).</p>
<p>Using ordinary UNIX tools like <c>sed</c> and <c>grep</c> one
can easily find answers to various questions like:</p>
<taglist>
<tag>Which OTP versions are <c>kernel-3.0</c> part of?</tag>
- <item><p><c> $ grep 'kernel-3\.0' otp_versions.table</c></p></item>
+ <item><p><c> $ grep ' kernel-3\.0 ' otp_versions.table</c></p></item>
<tag>In which OTP version was <c>kernel-3.0</c> introduced?</tag>
- <item><p><c> $ sed 's/#.*//;/kernel-3\.0/!d' otp_versions.table</c></p></item>
+ <item><p><c> $ sed 's/#.*//;/ kernel-3\.0 /!d' otp_versions.table</c></p></item>
</taglist>
<p>The above commands give a bit more information than the exact answers,
but adequate information when manually searching for answers to these