aboutsummaryrefslogtreecommitdiff
path: root/documentation/building.md
diff options
context:
space:
mode:
authorJakob Odersky <jodersky@gmail.com>2014-04-12 11:39:29 +0200
committerJakob Odersky <jodersky@gmail.com>2014-04-12 11:39:29 +0200
commit845b67b707d20ee59251d3c698cb03baf027aa5e (patch)
tree0f02593ab176893fda56e86f781c78ada4c9207e /documentation/building.md
parentcd255efe5c29efc013b4aa544033da56b0e36115 (diff)
downloadakka-serial-845b67b707d20ee59251d3c698cb03baf027aa5e.tar.gz
akka-serial-845b67b707d20ee59251d3c698cb03baf027aa5e.tar.bz2
akka-serial-845b67b707d20ee59251d3c698cb03baf027aa5e.zip
update documentation to include sha1 hashesv1.2.2
Diffstat (limited to 'documentation/building.md')
-rw-r--r--documentation/building.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/documentation/building.md b/documentation/building.md
index 43a3678..10e9d55 100644
--- a/documentation/building.md
+++ b/documentation/building.md
@@ -37,4 +37,7 @@ With this structure in mind, building a complete distribution of flow involves (
2. compiling and linking native sources for various platforms: `flow/nativeLink`
This is the most complicated and error-prone step in the build. It involves compiling and cross-compiling the native sources for various platforms and linking them.
Note that for this step to work, native builds for the current operating system have to be defined. Take a look at the build file to see how this is done (below ```trait Host``` in the file).
- After completing this step, native libraries for the different platforms are available to be copied and included in end-user applications. \ No newline at end of file
+ After completing this step, native libraries for the different platforms are available to be copied and included in end-user applications.
+
+ Note about versioning: when building and locally publishing projects, the usual convention is to append "-SNAPSHOT" to the version string. This practive however breaks version identification and badly hurts git (bisecting becomes a nightmare). Therefore, to identify a build artifact with a specific commit in the repository, a sha1 hash is appended to the version instead.
+ When publishing a new release, this hash may be ommited by setting the java system property "release=true", simply by running `sbt -Drelease=true`. \ No newline at end of file