X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-clustering-commons%2FREADME-FIRST;fp=opendaylight%2Fmd-sal%2Fsal-clustering-commons%2FREADME-FIRST;h=0000000000000000000000000000000000000000;hb=0121bc588e93461bddd977cec86f9d4800d2346a;hp=4791979c171ba9de3ef2dbf217f99a1a01586c07;hpb=424cda925030721160e3a1e2743bfb389caeb5bb;p=controller.git diff --git a/opendaylight/md-sal/sal-clustering-commons/README-FIRST b/opendaylight/md-sal/sal-clustering-commons/README-FIRST deleted file mode 100644 index 4791979c17..0000000000 --- a/opendaylight/md-sal/sal-clustering-commons/README-FIRST +++ /dev/null @@ -1,32 +0,0 @@ -Instructions on generating the protocol buffer Java source files - -These instructions are developers who are planning to generate the protocolbuffer java source files. - -1. We are using protocol buffer version 2.5.0 - you need to install the exact same version on your box. -The download link is https://code.google.com/p/protobuf/downloads/list. Download .tar/zip based on -your OS. - -2. Once downloaded the tar/zip and extracted follow the README instructions to compile protoc on your -machine - -3. Create your .proto (IDL) file in resources folder. Give appropriate package name so that the source - get generation in proper packages. For more information check - https://developers.google.com/protocol-buffers/docs/javatutorial - - For detailed information https://developers.google.com/protocol-buffers/docs/reference/java-generated - -4. To generate the java source files execute in sal-protocolbuffer-encoding directory - just run.sh in sal-protocolbuffer-encoding or execute the following command - - protoc --proto_path=src/main/resources --java_out=src/main/java src/main/resources/*.proto - -5. Run mvn clean install & build the .jar - -6. !!!WARNING!!! - never edit the generated sources files of protocol buffer - -7. !!!IMPORTANT!!! if you are planning to add new .proto file option java_package should begin with - org.opendaylight.controller.protobuff.messages to properly exclude from sonar. - -8. !!!IMPORTANT!!! for any new .proto file added you need to create corresponding version-compatibility-serialized-data - serialized test file under test/resources and a test case for one message in your .proto file. - Please follow the instruction in readme.txt in that folder