doc: emphasize building examples on master branch should follow COMPILING

Resolves #5115
This commit is contained in:
ZHANG Dapeng 2018-12-06 13:17:59 -08:00 committed by GitHub
parent 3202fcc7d9
commit 8ff92a4a7d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 26 additions and 11 deletions

View File

@ -1,12 +1,13 @@
Building gRPC-Java Building gRPC-Java
================== ==================
Building is only necessary if you are making changes to gRPC-Java. Building is only necessary if you are making changes to gRPC-Java or testing/using a non-released
version (e.g. master HEAD) of gRPC-Java library.
Building requires JDK 8, as our tests use TLS. Building requires JDK 8, as our tests use TLS.
grpc-java has a C++ code generation plugin for protoc. Since many Java grpc-java has a C++ code generation plugin for protoc. Since many Java
developers don't have C compilers installed and don't need to modify the developers don't have C compilers installed and don't need to run or modify the
codegen, the build can skip it. To skip, create the file codegen, the build can skip it. To skip, create the file
`<project-root>/gradle.properties` and add `skipCodegen=true`. `<project-root>/gradle.properties` and add `skipCodegen=true`.

View File

@ -42,8 +42,11 @@ $ VERSION_FILES=(
examples/android/clientcache/app/build.gradle examples/android/clientcache/app/build.gradle
examples/android/helloworld/app/build.gradle examples/android/helloworld/app/build.gradle
examples/android/routeguide/app/build.gradle examples/android/routeguide/app/build.gradle
examples/example-alts/build.gradle
examples/example-kotlin/build.gradle examples/example-kotlin/build.gradle
examples/example-kotlin/android/helloworld/app/build.gradle examples/example-kotlin/android/helloworld/app/build.gradle
examples/example-tls/build.gradle
examples/example-tls/pom.xml
) )
``` ```

View File

@ -9,8 +9,11 @@ You may want to read through the
[Quick Start Guide](https://grpc.io/docs/quickstart/java.html) [Quick Start Guide](https://grpc.io/docs/quickstart/java.html)
before trying out the examples. before trying out the examples.
To build the examples, run in this directory: To build the examples,
1. **[Install gRPC Java library SNAPSHOT locally, including code generation plugin](../COMPILING.md) (Only need this step for non-released versions, e.g. master HEAD).**
2. Run in this directory:
``` ```
$ ./gradlew installDist $ ./gradlew installDist
``` ```
@ -41,6 +44,9 @@ information.
## Maven ## Maven
If you prefer to use Maven: If you prefer to use Maven:
1. **[Install gRPC Java library SNAPSHOT locally, including code generation plugin](../COMPILING.md) (Only need this step for non-released versions, e.g. master HEAD).**
2. Run in this directory:
``` ```
$ mvn verify $ mvn verify
$ # Run the server $ # Run the server

View File

@ -14,12 +14,7 @@ PREREQUISITES
INSTALL INSTALL
------- -------
1. (Only for non-released versions) Install gRPC Java 1. **[Install gRPC Java library SNAPSHOT locally, including code generation plugin](../../COMPILING.md) (Only need this step for non-released versions, e.g. master HEAD).**
```sh
$ cd ../..
$ ./gradlew install -PskipCodegen=true
$ cd examples/android
```
2. Install the app 2. Install the app
```sh ```sh

View File

@ -9,8 +9,11 @@ You may want to read through the
[Quick Start Guide](https://grpc.io/docs/quickstart/java.html) [Quick Start Guide](https://grpc.io/docs/quickstart/java.html)
before trying out the examples. before trying out the examples.
To build the examples, run in this directory: To build the examples,
1. **[Install gRPC Java library SNAPSHOT locally, including code generation plugin](../../COMPILING.md) (Only need this step for non-released versions, e.g. master HEAD).**
2. Run in this directory:
``` ```
$ ./gradlew installDist $ ./gradlew installDist
``` ```

View File

@ -5,8 +5,11 @@ The example require grpc-java to already be built. You are strongly encouraged
to check out a git release tag, since there will already be a build of grpc to check out a git release tag, since there will already be a build of grpc
available. Otherwise you must follow [COMPILING](../COMPILING.md). available. Otherwise you must follow [COMPILING](../COMPILING.md).
To build the example, run in this directory: To build the example,
1. **[Install gRPC Java library SNAPSHOT locally, including code generation plugin](../../COMPILING.md) (Only need this step for non-released versions, e.g. master HEAD).**
2. Run in this directory:
``` ```
$ ../gradlew installDist $ ../gradlew installDist
``` ```
@ -97,6 +100,10 @@ That's it!
## Maven ## Maven
If you prefer to use Maven: If you prefer to use Maven:
1. **[Install gRPC Java library SNAPSHOT locally, including code generation plugin](../../COMPILING.md) (Only need this step for non-released versions, e.g. master HEAD).**
2. Run in this directory:
``` ```
$ mvn verify $ mvn verify
$ # Run the server $ # Run the server