From 236fb11189b8262cfb8a21a4a16742f5867c91fa Mon Sep 17 00:00:00 2001 From: Jisi Liu Date: Tue, 26 Jul 2016 17:32:31 -0700 Subject: Change documentation for javalite release --- protoc-artifacts/README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/protoc-artifacts/README.md b/protoc-artifacts/README.md index 205f04e3..fc1cac35 100644 --- a/protoc-artifacts/README.md +++ b/protoc-artifacts/README.md @@ -1,3 +1,14 @@ +# Special notes about building pre-compiled protoc-gen-javalite +This section is only visible from the javalite branch, which is forked from the +master branch to provide a stable java lite support. The ``protoc-gen-javalite`` +plugin can only be built and published in this branch. + +The sections below in this README are branched from the master, with all the mvn +commands changed to have an extra ``-f javalite-pom.xml`` parameter to load the +correct configuration for plugins. The original ``pom.xml`` in this branch is +renamed to ``protoc-pom.xml`` to prevent the protoc from being accidentally +published using this branch. + # Build scripts that publish pre-compiled protoc artifacts ``protoc`` is the compiler for ``.proto`` files. It generates language bindings for the messages and/or RPC services from ``.proto`` files. @@ -36,7 +47,7 @@ $ ./autogen.sh && ./configure && make ## To install artifacts locally The following command will install the ``protoc`` artifact to your local Maven repository. ``` -$ mvn install +$ mvn -f javalite-pom.xml install ``` ## Cross-compilation @@ -57,7 +68,7 @@ Frequently used values are: For example, MinGW32 only ships with 32-bit compilers, but you can still build 32-bit protoc under 64-bit Windows, with the following command: ``` -$ mvn install -Dos.detected.arch=x86_32 +$ mvn -f javalite-pom.xml install -Dos.detected.arch=x86_32 ``` ## To push artifacts to Maven Central @@ -81,7 +92,6 @@ Windows. Use the following command to deploy artifacts for the host platform to a staging repository. ``` -$ mvn clean deploy -P release $ mvn -f javalite-pom.xml clean deploy -P release ``` It creates a new staging repository. Go to @@ -93,7 +103,6 @@ subsequent deployments you will need to provide the repository name that you have found in the first deployment so that all artifacts go to the same repository: ``` -$ mvn clean deploy -P release -Dstaging.repository=comgoogle-123 $ mvn -f javalite-pom.xml clean deploy -P release -Dstaging.repository=comgoogle-123 ``` -- cgit v1.2.3