Commit 6bfe6d10 authored by chiaming2000's avatar chiaming2000
Browse files

Added build.setup.readme to describe protocol buffer setup requirement

and available scripts for the kinetic-protocol project dependency.
parent 8ce5cc7e
Loading
Loading
Loading
Loading

build.setup.readme

0 → 100644
+31 −0
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.

1. You must have protocol buffer installed on your development environment:

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.  

"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/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.  

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

//run protocol buffer compiler script and generate protocol buffer files.
 3.1 sh ./bin/buildProto.sh 

4. Proceed to normal maven build process (see kinetic.maven.readme). 
+7 −4
Original line number Diff line number Diff line
Maven command line for kinetic
==================================
Run maven commond line in <Kinetic-Folder> or in <Kinetic-Folder>/"submodule-name"

1, Run "mvn clean install" firstly
NOTE: please see build.setup.read for Prerequisite to build kinetic-java projects. 

To build kinetic-java projects, run maven commond line in <Kinetic-Folder> or in <Kinetic-Folder>/"submodule-name":

1, Run "mvn clean install". 

2, Build kinetic:
   mvn clean compile
@@ -13,6 +16,6 @@ Run maven commond line in <Kinetic-Folder> or in <Kinetic-Folder>/"submodule-nam
4, Build kinetic package:
   mvn clean package
   
   If you want to skip test cases:
   To skip test cases:
   mvn clean package -Dmaven.test.skip=true or mvn clean package -DskipTests