Commit 6309437b authored by chiaming2000's avatar chiaming2000
Browse files

Update readme files - install protocol buffer compiler is now optional

to build kinetic-java projects.
parent 7be22aa7
Loading
Loading
Loading
Loading
+1 −0
Original line number Diff line number Diff line
@@ -9,6 +9,7 @@ Suggested Development Environments
* Maven 3.0.3 or later: [http://maven.apache.org/download.cgi](http://maven.apache.org/download.cgi)

* Protocol buffer 2.5 [https://code.google.com/p/protobuf/downloads/list] (https://code.google.com/p/protobuf/downloads/list)
  (Optional requirement.  Required only if desired to change the kinetic.proto file. See build.setup.readme for details.)   

* For Windows 7 system, install the system patch package for jni:
  32 bit: [http://www.microsoft.com/en-us/download/details.aspx?id=5555](http://www.microsoft.com/en-us/download/details.aspx?id=5555)
+14 −10
Original line number Diff line number Diff line
Prerequisite to build kinetic-java projects.

The kinetic-java projects depends on kinetic.proto file that hosted on https://github.com/Seagate/kinetic-protocol.git. 
The file is required to be down-loaded to your local development environment and compiled into Java files before the 
projects can be built.
The kinetic.proto file is hosted on https://github.com/Seagate/kinetic-protocol.git. 

If you already have protocol buffer installed, you may proceed to normal maven project build (#4 below).  
Otherwise, please setup the protocol buffer as follows.
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.  

1. You must have protocol buffer installed on your development environment:
Please proceed to #4 if you do not need to change the Kinetic protocol.

Please proceed to #4 if you already have protocol buffer installed.  

Please setup the protocol buffer compiler as follows if you do require to change the Kinetic protocol.

1. Install protocol buffer compiler on your development environment:

https://code.google.com/p/protobuf/

@@ -15,13 +19,13 @@ https://developers.google.com/protocol-buffers/docs/javatutorial

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

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

//cd to project root
2.1 cd <kinetic-java>

//run syncProtoFromRepo.sh to get the latest kinetic.proto file.
2.2 sh ./bin/forceSyncLatestProtoFromRepo.sh
//run syncProtoFromRepo.sh to get the desired version of kinetic.proto file.
2.2 sh ./bin/syncProtoFromRepo.sh

3. Compile protocol buffer files and generate Java files into com.seagate.kinetic.proto package. 
The package is under <kinetic-java>/kinetic-common/src/main/java folder.  
+1 −4
Original line number Diff line number Diff line
@@ -20,6 +20,3 @@ To build kinetic-java projects, run maven command line in <Kinetic-Folder>:
   
   To skip test cases:
   mvn clean package -Dmaven.test.skip=true or mvn clean package -DskipTests
 No newline at end of file
   
   To skip sync kinetic.proto file with kinetic-protocol repository (for example, no Internet connections, etc): 
   mvn clean compile -DskipProtoSync
 No newline at end of file