Minor wording update to release engineering instructions.

[simantics/platform.git] / releng / doc / release.md

diff --git a/releng/doc/release.md b/releng/doc/release.md
index b16736e80aeed1e5cef81c33852eed98d0a115ac..79359efd215e1346ee9624f7192c4708960ad86a 100644 (file)
--- a/releng/doc/release.md
+++ b/releng/doc/release.md
@@ -22,13 +22,13 @@
 
 ----
 
-# Released Plug-in Components and Products  
+# Released Plug-in Components and Products
 
 There are both plug-in components and products that are part of the "Simantics release train" that shall be released simultaneously to a major or minor Simantics release.
 
-Plug-in components are installable features that are deployed online as P2 repositories for general availability. Products are deployed as ZIP files and made available online in designated locations on simantics.org. 
+Plug-in components are installable features that are deployed online as P2 repositories for general availability. Products are deployed as ZIP files and made available online in designated locations on simantics.org.
 
-Products that are part of the release train: 
+Products that are part of the release train:
 * Simantics Desktop
 * Simantics System Dynamics Tool - [simantics/sysdyn.git](https://www.simantics.org:8088/r/gitweb?p=simantics/sysdyn.git;a=summary)
 
@@ -38,7 +38,7 @@ Plug-in components that are part of the release train:
 * FMI Studio - [members/fmi.git](https://www.simantics.org:8088/r/gitweb?p=members/fmi.git;a=summary)
 * Simupedia - [Members SVN](https://www.simantics.org/svn/members/simupedia)
 
-For simplicity, each of these components are versioned accoring to platform versioning, i.e. for Platform SDK 1.26.0 there will be Simantics Desktop 1.26.0, Sysdyn 1.26.0, and so on.  
+For simplicity, each of these components are versioned accoring to platform versioning, i.e. for Platform SDK 1.26.0 there will be Simantics Desktop 1.26.0, Sysdyn 1.26.0, and so on.
 
 ----
 
@@ -95,7 +95,7 @@ With service releases, branch from an existing `release/*` branch instead.
    <unit id="org.simantics.sdk.source.feature.group" version="x.y.z[.w]"/>
    ~~~
 
-   Next, replace the following rows in both mentioned files:   
+   Next, replace the following rows in both mentioned files:
 
    ~~~
    <repository location="http://www.simantics.org/download/master/sdk"/>
@@ -134,7 +134,7 @@ With service releases, branch from an existing `release/*` branch instead.
 
         refs #xxxx
 
-   where `#xxxx` is the number of the x.y.z[.w] release engineering issue and push them to remote 
+   where `#xxxx` is the number of the x.y.z[.w] release engineering issue and push them to remote
 
         git push origin release/x.y.z[.w]
 
@@ -186,21 +186,21 @@ For each wiki page:
 When the release branches are ready for the release, tag them with the tag `vx.y.z[.w]`:
 
     git clone ssh://<user>@www.simantics.org:29418/simantics/platform.git
-    cd platform    
+    cd platform
     git checkout release/x.y.z[.w]
-    git tag vx.y.z[.w] -m "Simantics x.y.z[.w] release"
+    git tag vx.y.z[.w] -m "Simantics x.y.z[.w] simultaneous release"
     git push origin --tags
 
     git clone ssh://<user>@www.simantics.org:29418/simantics/third-party.git
     cd third-party
     git checkout release/x.y.z[.w]
-    git tag vx.y.z[.w] -m "Simantics x.y.z[.w] release"
+    git tag vx.y.z[.w] -m "Simantics x.y.z[.w] simultaneous release"
     git push origin --tags
 
 > Note The -m argument must be supplied to create an [annotated tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging).
 > Only annotated or signed tags can be pushed to Gerrit.
 
-## Backup documentation wiki databases 
+## Backup documentation wiki databases
 
 This step is only necessary for major/minor releases, not for service releases.
 
@@ -211,7 +211,7 @@ The wiki databases to be backed up are:
 These are MediaWiki installations. The only sane way to "tag" the documentation
 is to back up the mysql database backing the wiki. Should the wiki be required
 at a later time for some reason, we'll put the documentation up then in a
-separate Mediawiki installation. 
+separate Mediawiki installation.
 
 1. Dump documentation wiki databases using [dump-wikis.sh](./dump-wikis.sh) script.
 2. Put the generated backup x.y.z.tar.gz at /var/backup/simantics-releases/x.y.z/wiki/
@@ -255,7 +255,7 @@ separate Mediawiki installation.
 **Newsletter template:**
 ~~~
 Hello everyone,
-   
+
 Simantics release x.y.z[.w] has been released. Head over to
 https://www.simantics.org/redmine/news/<news number>
 for the release news.
@@ -283,6 +283,6 @@ Insert some general thoughts on the release...
 
 
 * Incorporate tutorial code in the platform repository as a separate folder to allow platform builds to directly ensure that the tutorial code still builds OK
- 
+
 * Start using https://github.com/mbarbero/fr.obeo.releng.targetplatform to generate `.target` files. `.tpd` files allow specifying version ranges instead of specific versions.