Merge pull request #30 from Kinetic/0.8.0.5-release (b250499e) · Commits · kinetic-archive / kinetic-java

README.md

+5 −5

Original line number	Diff line number	Diff line
		@@ -31,10 +31,10 @@ kinetic-java provides the Java API and Simulator for the Kinetic Open Storage Pl
		[https://developers.seagate.com/display/KV/Kinetic+Open+Storage+Documentation+Wiki] (https://developers.seagate.com/display/KV/Kinetic+Open+Storage+Documentation+Wiki)

		Client bootstrap class:
		[https://github.com/Seagate/kinetic-java/blob/master/kinetic-client/src/main/java/kinetic/client/KineticClientFactory.java] (https://github.com/Seagate/kinetic-java/blob/master/kinetic-client/src/main/java/kinetic/client/KineticClientFactory.java)
		[https://github.com/Kinetic/kinetic-java/blob/master/kinetic-client/src/main/java/kinetic/client/KineticClientFactory.java] (https://github.com/Kinetic/kinetic-java/blob/master/kinetic-client/src/main/java/kinetic/client/KineticClientFactory.java)

		Simulator bootstrap class:
		[https://github.com/Seagate/kinetic-java/blob/master/kinetic-simulator/src/main/java/kinetic/simulator/KineticSimulator.java](https://github.com/Seagate/kinetic-java/blob/master/kinetic-simulator/src/main/java/kinetic/simulator/KineticSimulator.java)
		[https://github.com/Kinetic/kinetic-java/blob/master/kinetic-simulator/src/main/java/kinetic/simulator/KineticSimulator.java](https://github.com/Kinetic/kinetic-java/blob/master/kinetic-simulator/src/main/java/kinetic/simulator/KineticSimulator.java)

		Getting Started With Kinetic drives
		===================================
		@@ -45,7 +45,7 @@ Getting Started With Kinetic drives

		Getting Started With Development
		================================
		1. Clone the code: `git clone https://github.com/Seagate/kinetic-java.git`
		1. Clone the code: `git clone https://github.com/Kinetic/kinetic-java.git`
		1. Build the runtime jar files as stated in Getting Started with Simulator below
		1. Run the integration tests against the Java Simulator: `mvn test -DargLine="-Xmx500M"`
		1. Run the integration tests but exclude specific files: `mvn test -Dmaven.test.excludes="/File.java,/OtherFile.java"
		@@ -113,7 +113,7 @@ Examples are located at the following directory.

		Kinetic Javadoc location
		=================================
		To browse Javadoc: [http://seagate.github.io/kinetic-java/] (http://seagate.github.io/kinetic-java/)
		To browse Javadoc: [http://kinetic.github.io/kinetic-java/] (http://kinetic.github.io/kinetic-java/)

		To generate Javadoc:

		@@ -125,7 +125,7 @@ To generate Javadoc:

		Latest Kinetic release, protocol dependency, and runtime dependencies on maven central
		=================================
		* kinetic-releases: [https://github.com/Seagate/kinetic-java/releases] (https://github.com/Seagate/kinetic-java/releases)
		* kinetic-releases: [https://github.com/Kinetic/kinetic-java/releases] (https://github.com/Kinetic/kinetic-java/releases)

		Run smoke test against simulator or kinetic drive
		==================================

bin/readme.txt

+1 −1

Original line number	Diff line number	Diff line
		@@ -342,7 +342,7 @@ Usage of Kinetic Admin API script

		Usage of proto scripts
		===========================
		1. Sync protocol file from Kinetic-Protocol github repo [https://github.com/Seagate/Kinetic-Protocol.git] to local.
		1. Sync protocol file from Kinetic-Protocol github repo [https://github.com/Kinetic/Kinetic-Protocol.git] to local.
		$sh syncProtoFromRepo.sh to get the latest version.
		$sh syncProtoFromRepo.sh $commitHash to get the commit hash version.
		For example,

bin/syncProtoFromRepo.sh

+1 −1

Original line number	Diff line number	Diff line
		@@ -3,7 +3,7 @@ BASE_DIR=`dirname "$0"`/..
		BASE_DIR=`cd "$BASE_DIR"; pwd`
		#echo "BASE_DIR=$BASE_DIR"

		PROTO_REPO_URL=https://github.com/Seagate/Kinetic-Protocol.git
		PROTO_REPO_URL=https://github.com/Kinetic/Kinetic-Protocol.git
		PROTO_FILE=$BASE_DIR/kinetic-common/src/main/java/com/seagate/kinetic/proto/kinetic.proto
		CLONE_DIR=$BASE_DIR/bin/Kinetic-Protocol
		PROTO_RELEASE_VERSION=3.0.5

build.setup.readme

+2 −2

Original line number	Diff line number	Diff line
		Prerequisite to build kinetic-java projects.

		The kinetic.proto file is hosted on https://github.com/Seagate/kinetic-protocol.git.
		The kinetic.proto file is hosted on https://github.com/Kinetic/kinetic-protocol.git.

		The kinetic.proto file is required to be down-loaded to your local development environment and compiled into Java files
		if you like to change the Kinetic protocol.
		@@ -17,7 +17,7 @@ https://code.google.com/p/protobuf/

		https://developers.google.com/protocol-buffers/docs/javatutorial

		2. Obtain a copy of kinetic.proto from https://github.com/Seagate/kinetic-protocol.git repository.
		2. Obtain a copy of kinetic.proto from https://github.com/Kinetic/kinetic-protocol.git repository.

		"syncProtoFromRepo.sh" script is provided to facilitate the work:

kinetic.maven.readme

+1 −1

Original line number	Diff line number	Diff line
		@@ -2,7 +2,7 @@ Maven command line for kinetic
		==================================

		NOTE: please verify all the required "Suggested Development Environments" are satisfied as stated at the link (README.md):
		https://github.com/Seagate/kinetic-java
		https://github.com/Kinetic/kinetic-java

		NOTE: Please also verify that JAVA_HOME is defined in your development environment:
		http://maven.apache.org/download.cgi