Fix config-manager activator

[controller.git] / opendaylight / md-sal / sal-protocolbuffer-encoding / README-FIRST

diff --git a/opendaylight/md-sal/sal-protocolbuffer-encoding/README-FIRST b/opendaylight/md-sal/sal-protocolbuffer-encoding/README-FIRST
index 778d8c6162c988bb282d5995e7d3e3ab5615ba43..4791979c171ba9de3ef2dbf217f99a1a01586c07 100644 (file)
--- a/opendaylight/md-sal/sal-protocolbuffer-encoding/README-FIRST
+++ b/opendaylight/md-sal/sal-protocolbuffer-encoding/README-FIRST
@@ -20,4 +20,13 @@ machine
 
  protoc --proto_path=src/main/resources --java_out=src/main/java src/main/resources/*.proto
 
-5. Run mvn clean install and resolve any trailing spaces issues & build the .jar
+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