fix markdown

pull/10698/head
Jan Tattermusch 8 years ago
parent dd109da280
commit a22a19fd64
  1. 4
      doc/server_side_auth.md
  2. 2
      examples/cpp/README.md
  3. 2
      examples/cpp/cpptutorial.md
  4. 2
      examples/csharp/route_guide/README.md
  5. 2
      examples/node/dynamic_codegen/route_guide/README.md
  6. 2
      examples/node/static_codegen/route_guide/README.md
  7. 2
      examples/objective-c/auth_sample/README.md
  8. 2
      examples/objective-c/helloworld/README.md
  9. 2
      examples/objective-c/route_guide/README.md
  10. 2
      examples/php/route_guide/README.md
  11. 2
      examples/ruby/errors_and_cancellation/README.md
  12. 2
      examples/ruby/route_guide/README.md
  13. 12
      tools/grift/README.md
  14. 24
      tools/run_tests/README.md
  15. 6
      vsprojects/README.md

@ -13,7 +13,7 @@ The contents of the *auth properties* are populated by an *auth interceptor*. Th
WARNING: AuthContext is the only reliable source of truth when it comes to authenticating RPCs. Using any other call/context properties for authentication purposes is wrong and inherently unsafe. WARNING: AuthContext is the only reliable source of truth when it comes to authenticating RPCs. Using any other call/context properties for authentication purposes is wrong and inherently unsafe.
####Example AuthContext contents #### Example AuthContext contents
For secure channel using mutual TLS authentication with both client and server certificates (test certificates from this repository are used). For secure channel using mutual TLS authentication with both client and server certificates (test certificates from this repository are used).
@ -45,7 +45,7 @@ gRPC comes with some basic "interceptors" already built-in.
WARNING: While there is a public API that allows anyone to write their own custom interceptor, please think twice before using it. WARNING: While there is a public API that allows anyone to write their own custom interceptor, please think twice before using it.
There are legitimate uses for custom interceptors but you should keep in mind that as auth interceptors essentially decide which RPCs are authenticated and which are not, their code is very sensitive from the security perspective and getting things wrong might have serious consequences. If unsure, we strongly recommend to rely on official & proven interceptors that come with gRPC. There are legitimate uses for custom interceptors but you should keep in mind that as auth interceptors essentially decide which RPCs are authenticated and which are not, their code is very sensitive from the security perspective and getting things wrong might have serious consequences. If unsure, we strongly recommend to rely on official & proven interceptors that come with gRPC.
####Available auth interceptors #### Available auth interceptors
- TLS/SSL certificate authentication (built into gRPC's security layer, automatically used whenever you use a secure connection) - TLS/SSL certificate authentication (built into gRPC's security layer, automatically used whenever you use a secure connection)
- (coming soon) JWT auth token authentication - (coming soon) JWT auth token authentication
- more will be added over time - more will be added over time

@ -1,4 +1,4 @@
#gRPC in 3 minutes (C++) # gRPC in 3 minutes (C++)
## Installation ## Installation

@ -1,4 +1,4 @@
#gRPC Basics: C++ # gRPC Basics: C++
This tutorial provides a basic C++ programmer's introduction to working with This tutorial provides a basic C++ programmer's introduction to working with
gRPC. By walking through this example you'll learn how to: gRPC. By walking through this example you'll learn how to:

@ -1,4 +1,4 @@
#gRPC Basics: C# sample code # gRPC Basics: C# sample code
The files in this folder are the samples used in [gRPC Basics: C#][], The files in this folder are the samples used in [gRPC Basics: C#][],
a detailed tutorial for using gRPC in C#. a detailed tutorial for using gRPC in C#.

@ -1,4 +1,4 @@
#gRPC Basics: Node.js sample code # gRPC Basics: Node.js sample code
The files in this folder are the samples used in [gRPC Basics: Node.js][], a detailed tutorial for using gRPC in Node.js. The files in this folder are the samples used in [gRPC Basics: Node.js][], a detailed tutorial for using gRPC in Node.js.

@ -1,4 +1,4 @@
#gRPC Basics: Node.js sample code # gRPC Basics: Node.js sample code
The files in this folder are the samples used in [gRPC Basics: Node.js][], a detailed tutorial for using gRPC in Node.js. The files in this folder are the samples used in [gRPC Basics: Node.js][], a detailed tutorial for using gRPC in Node.js.

@ -1,3 +1,3 @@
#OAuth2 on gRPC: Objective-C # OAuth2 on gRPC: Objective-C
This is the supporting code for the tutorial "[OAuth2 on gRPC: Objective-C](http://www.grpc.io/docs/tutorials/auth/oauth2-objective-c.html)." This is the supporting code for the tutorial "[OAuth2 on gRPC: Objective-C](http://www.grpc.io/docs/tutorials/auth/oauth2-objective-c.html)."

@ -1,4 +1,4 @@
#gRPC in 3 minutes (Objective-C) # gRPC in 3 minutes (Objective-C)
## Installation ## Installation

@ -1,4 +1,4 @@
#gRPC Basics: Objective-C # gRPC Basics: Objective-C
This is the supporting code for the tutorial "[gRPC Basics: Objective-C](http://www.grpc.io/docs/tutorials/basic/objective-c.html)." This is the supporting code for the tutorial "[gRPC Basics: Objective-C](http://www.grpc.io/docs/tutorials/basic/objective-c.html)."

@ -1,4 +1,4 @@
#gRPC Basics: PHP sample code # gRPC Basics: PHP sample code
The files in this folder are the samples used in [gRPC Basics: PHP][], The files in this folder are the samples used in [gRPC Basics: PHP][],
a detailed tutorial for using gRPC in PHP. a detailed tutorial for using gRPC in PHP.

@ -1,4 +1,4 @@
#Errors and Cancelletion code samples for grpc-ruby # Errors and Cancelletion code samples for grpc-ruby
The examples in this directory show use of grpc errors. The examples in this directory show use of grpc errors.

@ -1,4 +1,4 @@
#gRPC Basics: Ruby sample code # gRPC Basics: Ruby sample code
The files in this folder are the samples used in [gRPC Basics: Ruby][], The files in this folder are the samples used in [gRPC Basics: Ruby][],
a detailed tutorial for using gRPC in Ruby. a detailed tutorial for using gRPC in Ruby.

@ -1,6 +1,4 @@
Copyright 2016 Google Inc. # Documentation
#Documentation
grift is integration of [Apache Thrift](https://github.com/apache/thrift.git) Serializer with gRPC. grift is integration of [Apache Thrift](https://github.com/apache/thrift.git) Serializer with gRPC.
@ -8,19 +6,19 @@ This integration allows you to use grpc to send thrift messages in C++ and java.
grift uses Compact Protocol to serialize thrift messages. grift uses Compact Protocol to serialize thrift messages.
##generating grpc plugins for thrift services ## generating grpc plugins for thrift services
###CPP ### C++
```sh ```sh
$ thrift --gen cpp <thrift-file> $ thrift --gen cpp <thrift-file>
``` ```
###JAVA ### Java
```sh ```sh
$ thrift --gen java <thrift-file> $ thrift --gen java <thrift-file>
``` ```
#Installation # Installation
Before Installing thrift make sure to apply this [patch](grpc_plugins_generator.patch) to third_party/thrift. Before Installing thrift make sure to apply this [patch](grpc_plugins_generator.patch) to third_party/thrift.
Go to third_party/thrift and follow the [INSTALLATION](https://github.com/apache/thrift.git) instructions to install thrift with commit id bcad91771b7f0bff28a1cac1981d7ef2b9bcef3c. Go to third_party/thrift and follow the [INSTALLATION](https://github.com/apache/thrift.git) instructions to install thrift with commit id bcad91771b7f0bff28a1cac1981d7ef2b9bcef3c.

@ -1,44 +1,44 @@
#Overview # Overview
This directory contains scripts that facilitate building and running tests. We are using python scripts as entrypoint for our This directory contains scripts that facilitate building and running tests. We are using python scripts as entrypoint for our
tests because that gives us the opportunity to run tests using the same commandline regardless of the platform you are using. tests because that gives us the opportunity to run tests using the same commandline regardless of the platform you are using.
#Unit tests (run_tests.py) # Unit tests (run_tests.py)
Builds gRPC in given language and runs unit tests. Use `tools/run_tests/run_tests.py --help` for more help. Builds gRPC in given language and runs unit tests. Use `tools/run_tests/run_tests.py --help` for more help.
######Example ###### Example
`tools/run_tests/run_tests.py -l csharp -c dbg` `tools/run_tests/run_tests.py -l csharp -c dbg`
######Useful options (among many others) ###### Useful options (among many others)
- `--use_docker` Builds a docker container containing all the prerequisites for given language and runs the tests under that container. - `--use_docker` Builds a docker container containing all the prerequisites for given language and runs the tests under that container.
- `--build_only` Only build, do not run the tests. - `--build_only` Only build, do not run the tests.
#Interop tests (run_interop_tests.py) # Interop tests (run_interop_tests.py)
Runs tests for cross-platform/cross-language interoperability. For more details, see [Interop tests descriptions](/doc/interop-test-descriptions.md) Runs tests for cross-platform/cross-language interoperability. For more details, see [Interop tests descriptions](/doc/interop-test-descriptions.md)
The script is also capable of running interop tests for grpc-java and grpc-go, using sources checked out alongside the ones of the grpc repository. The script is also capable of running interop tests for grpc-java and grpc-go, using sources checked out alongside the ones of the grpc repository.
######Example ###### Example
`tools/run_tests/run_interop_tests.py -l csharp -s c++ --use_docker` (run interop tests with C# client and C++ server) `tools/run_tests/run_interop_tests.py -l csharp -s c++ --use_docker` (run interop tests with C# client and C++ server)
Note: if you see an error like `no space left on device` when running the Note: if you see an error like `no space left on device` when running the
interop tests using Docker, make sure that Docker is building the image files in interop tests using Docker, make sure that Docker is building the image files in
a location with sufficient disk space. a location with sufficient disk space.
#Performance benchmarks (run_performance_tests.py) # Performance benchmarks (run_performance_tests.py)
Runs predefined benchmark scenarios for given languages. Besides the simple configuration of running all the scenarios locally, Runs predefined benchmark scenarios for given languages. Besides the simple configuration of running all the scenarios locally,
the script also supports orchestrating test runs with client and server running on different machines and uploading the results the script also supports orchestrating test runs with client and server running on different machines and uploading the results
to BigQuery. to BigQuery.
######Example ###### Example
`tools/run_tests/run_peformance_tests.py -l c++ node` `tools/run_tests/run_peformance_tests.py -l c++ node`
######Useful options ###### Useful options
- `--regex` use regex to select particular scenarios to run. - `--regex` use regex to select particular scenarios to run.
#Stress tests (run_stress_tests.py) # Stress tests (run_stress_tests.py)
Runs modified interop tests clients and servers under heavy load for an extended period of time to discover potential stability issues. Runs modified interop tests clients and servers under heavy load for an extended period of time to discover potential stability issues.
The tests are internally using Kubernetes to run the client and server on GKE and upload statistics to BigQuery. The tests are internally using Kubernetes to run the client and server on GKE and upload statistics to BigQuery.
@ -47,10 +47,10 @@ The tests are internally using Kubernetes to run the client and server on GKE an
The directory `tools/run_tests/stress_test/configs/` contains the config files for several scenarios The directory `tools/run_tests/stress_test/configs/` contains the config files for several scenarios
#Artifacts & Packages (task_runner.py) # Artifacts & Packages (task_runner.py)
A generalized framework for running predefined tasks based on their labels. We use this to building binary artifacts & distrib packages and testing them) A generalized framework for running predefined tasks based on their labels. We use this to building binary artifacts & distrib packages and testing them)
######Example ###### Example
`tools/run_tests/task_runner.py -f python artifact linux x64` (build tasks with labels `python`, `artifact`, `linux`, and `x64`) `tools/run_tests/task_runner.py -f python artifact linux x64` (build tasks with labels `python`, `artifact`, `linux`, and `x64`)

@ -1,10 +1,10 @@
#Pre-generated MS Visual Studio project & solution files # Pre-generated MS Visual Studio project & solution files
Versions 2013 and 2015 are both supported. You can use [their respective Versions 2013 and 2015 are both supported. You can use [their respective
community community
editions](https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx). editions](https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx).
#Building # Building
We are using [NuGet](http://www.nuget.org) to pull zlib and openssl dependencies. We are using [NuGet](http://www.nuget.org) to pull zlib and openssl dependencies.
If you don't have Visual Studio NuGet plugin installed, you'll need to If you don't have Visual Studio NuGet plugin installed, you'll need to
download nuget.exe from the web and manually restore the NuGet packages. download nuget.exe from the web and manually restore the NuGet packages.
@ -19,7 +19,7 @@ After that, you can build the solution using one of these options:
1. open `grpc.sln` with Visual Studio and hit "Build". 1. open `grpc.sln` with Visual Studio and hit "Build".
2. build from commandline using `msbuild grpc.sln /p:Configuration=Debug` 2. build from commandline using `msbuild grpc.sln /p:Configuration=Debug`
#C/C++ Test Dependencies # C/C++ Test Dependencies
* gtest isn't available as a git repo like the other dependencies. download it and add it to `/third_party/gtest/` (the folder will end up with `/build-aux/`, `/cmake/`, `/codegear/`, etc. folders in it). * gtest isn't available as a git repo like the other dependencies. download it and add it to `/third_party/gtest/` (the folder will end up with `/build-aux/`, `/cmake/`, `/codegear/`, etc. folders in it).
* if using vs2013: open/import the gtest solution in `/msvc/`, and save over the first solution (you will have to change it from read-only). change all projects to use `/MDd` (Property Pages - C/C++ - Code Generation - Runtime Library) and build. This is a "multithreaded debug" setting and it needs to match grpc. * if using vs2013: open/import the gtest solution in `/msvc/`, and save over the first solution (you will have to change it from read-only). change all projects to use `/MDd` (Property Pages - C/C++ - Code Generation - Runtime Library) and build. This is a "multithreaded debug" setting and it needs to match grpc.
* build all * build all

Loading…
Cancel
Save