incubator-edgent-samples git commit: Update info about building against a different runtime version

[dl...@apache.org]

Repository: incubator-edgent-samples
Updated Branches:
  refs/heads/develop 5ab25707f -> c1448faa3


Update info about building against a different runtime version


Project: http://git-wip-us.apache.org/repos/asf/incubator-edgent-samples/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-edgent-samples/commit/c1448faa
Tree: http://git-wip-us.apache.org/repos/asf/incubator-edgent-samples/tree/c1448faa
Diff: http://git-wip-us.apache.org/repos/asf/incubator-edgent-samples/diff/c1448faa

Branch: refs/heads/develop
Commit: c1448faa38920b65043672949f41009bf80a68a0
Parents: 5ab2570
Author: Dale LaBossiere <dl...@us.ibm.com>
Authored: Wed Nov 22 11:53:00 2017 -0500
Committer: Dale LaBossiere <dl...@us.ibm.com>
Committed: Wed Nov 22 11:53:00 2017 -0500

----------------------------------------------------------------------
 README.md | 27 ++++++++++++++++++++-------
 pom.xml   |  2 +-
 2 files changed, 21 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-edgent-samples/blob/c1448faa/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 30b8cd8..b1c115a 100644
--- a/README.md
+++ b/README.md
@@ -65,9 +65,9 @@ Getting Started https://edgent.apache.org/docs/edgent-getting-started
 
 # Setup
 
-Once you have downloaded and unpacked the samples source bundle 
-or cloned the the samples repository you need to download
-these additional development software tools.
+Once you have downloaded or cloned the the samples repository
+from https://github.com/apache/incubator-edgent-samples
+you need to download these additional development software tools.
 
 * Java 8 - The development setup assumes Java 8
 
@@ -86,8 +86,8 @@ in a maven repository such as Maven Central.
 
 Alternatively, you can download the Edgent SDK sources and build them,
 populating your local maven repository.  The samples
-will then use those Edgent SDK jars.  Adjust the `edgent.version` 
-property in the top level samples `pom.xml` accordingly.
+will then use those Edgent SDK jars. See the note below about
+building against a different Edgent runtime version.
 See [downloads](https://edgent.apache.org/docs/downloads) 
 for downloading the Edgent SDK sources.
 
@@ -103,14 +103,27 @@ which is not supported on the Android platform.
 
 Build the samples
 ```sh
-./mvnw clean package  # -Pplatform-java7 and/or -Dedgent.runtime.version=<the-version> as needed
+./mvnw clean package  # -Pplatform-java7 as needed
 ```
 
 A standard jar and uber jar are created for each sample category
 in the sample category's target directory: `<category>/target`.
 
+## Building against a different Edgent runtime version
 
-## Running the samples
+To change the version of the Edgent runtime artifacts used,
+edit the `edgent.runtime.version` property in the top level
+`pom.xml`. e.g.,
+```xml
+    <edgent.runtime.version>1.3.0-SNAPSHOT</edgent.runtime.version>
+```
+
+Note: Do NOT override the value via
+`./mvnw ... -Dedgent.runtime.version=<the-version>`.
+The build will not behave as desired.
+
+
+# Running the samples
 
 See the `README.md` in each sample category directory for information
 on running the samples.

http://git-wip-us.apache.org/repos/asf/incubator-edgent-samples/blob/c1448faa/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index af32c81..fe2d0ad 100644
--- a/pom.xml
+++ b/pom.xml
@@ -38,7 +38,7 @@
     <samples.projname.platform>(Java 8)</samples.projname.platform>  <!--  tweaked by -Pplatform-* -->
     <edgent.runtime.platform/> <!-- set by -Pplatform-* -->    
     <edgent.runtime.groupId>org.apache.edgent${edgent.runtime.platform}</edgent.runtime.groupId>
-    <!-- override via 'mvn ... -Dedgent.runtime.version=<the-version>' -->
+    <!-- NOTE: do NOT override via 'mvn ... -Dedgent.runtime.version=<the-version>' -->
     <edgent.runtime.version>1.2.0</edgent.runtime.version>
 
     <java.version>1.8</java.version>