Repository: flume Updated Branches: refs/heads/trunk ef54f9fd6 -> b54f085ff
FLUME-2175. Document Protocol Buffer upgrade steps Update Developer Guide with notes on how to upgrade Protocol Buffer version. Reviewers: Ashish Paliwal, Attila Simon (Roshan Naik via Denes Arvay) Project: http://git-wip-us.apache.org/repos/asf/flume/repo Commit: http://git-wip-us.apache.org/repos/asf/flume/commit/b54f085f Tree: http://git-wip-us.apache.org/repos/asf/flume/tree/b54f085f Diff: http://git-wip-us.apache.org/repos/asf/flume/diff/b54f085f Branch: refs/heads/trunk Commit: b54f085ffa89b74c9e91e478e864424bfbe0a7a2 Parents: ef54f9f Author: Roshan Naik <[email protected]> Authored: Tue Jul 4 11:47:52 2017 +0200 Committer: Denes Arvay <[email protected]> Committed: Tue Jul 4 11:54:41 2017 +0200 ---------------------------------------------------------------------- flume-ng-doc/sphinx/FlumeDeveloperGuide.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flume/blob/b54f085f/flume-ng-doc/sphinx/FlumeDeveloperGuide.rst ---------------------------------------------------------------------- diff --git a/flume-ng-doc/sphinx/FlumeDeveloperGuide.rst b/flume-ng-doc/sphinx/FlumeDeveloperGuide.rst index f1d5ccc..ffe56c7 100644 --- a/flume-ng-doc/sphinx/FlumeDeveloperGuide.rst +++ b/flume-ng-doc/sphinx/FlumeDeveloperGuide.rst @@ -114,6 +114,18 @@ Please note that Flume builds requires that the Google Protocol Buffers compiler be in the path. You can download and install it by following the instructions `here <https://developers.google.com/protocol-buffers/>`_. +Updating Protocol Buffer Version +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +File channel has a dependency on Protocol Buffer. When updating the version of Protocol Buffer +used by Flume, it is necessary to regenerate the data access classes using the protoc compiler +that is part of Protocol Buffer as follows. + +#. Install the desired version of Protocol Buffer on your local machine +#. Update version of Protocol Buffer in pom.xml +#. Generate new Protocol Buffer data access classes in Flume: ``cd flume-ng-channels/flume-file-channel; mvn -P compile-proto clean package -DskipTests`` +#. Add Apache license header to any of the generated files that are missing it +#. Rebuild and test Flume: ``cd ../..; mvn clean install`` + Developing custom components ----------------------------
