diff options
author | Mathieu Leenhardt <mleenhardt@users.noreply.github.com> | 2016-04-06 23:04:16 +0200 |
---|---|---|
committer | Mathieu Leenhardt <mleenhardt@users.noreply.github.com> | 2016-04-06 23:04:16 +0200 |
commit | efa6af7381a78c67785f1717fa6497e1577f6638 (patch) | |
tree | 3e8e8ad72a994a72d422d971f2b93489174b6955 /CONTRIBUTING.md | |
parent | 9ef407b0d771878ca1c0f35b4554dd64a3492908 (diff) | |
parent | 39a96967f1b003391b02317bf7c6fb003edc4722 (diff) |
Merge branch 'master' into calloptions-fluent
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 21 |
1 files changed, 17 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9423c46547..35eb5e6138 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,7 @@ In order to protect both you and ourselves, you will need to sign the ### Technical requirements You will need several tools to work with this repository. In addition to all of -the packages described in the [INSTALL](INSTALL) file, you will also need +the packages described in the [INSTALL](INSTALL.md) file, you will also need python, and the mako template renderer. To install the latter, using pip, one should simply be able to do `pip install mako`. @@ -21,6 +21,15 @@ In order to run all of the tests we provide, you will need valgrind and clang. More specifically, under debian, you will need the package libc++-dev to properly run all the tests. +Compiling and running grpc C++ tests depend on protobuf 3.0.0, gtest and gflags. +Although gflags is provided in third_party, you will need to manually install +that dependency on your system to run these tests. Under a Debian or Ubuntu +system, you can install the gtests and gflags packages using apt-get: + +```sh + $ [sudo] apt-get install libgflags-dev libgtest-dev +``` + If you are planning to work on any of the languages other than C and C++, you will also need their appropriate development environments. @@ -36,9 +45,13 @@ In order to run most of the available tests, one would need to run: `./tools/run_tests/run_tests.py` -If you want to run all the possible tests for any of the languages {c, c++, node, php, python}, do this: +If you want to run tests for any of the languages {c, c++, csharp, node, objc, php, python, ruby}, do this: + +`./tools/run_tests/run_tests.py -l <lang>` + +To know about the list of available commands, do this: -`./tools/run_tests/run_tests.py -l <lang> -c all` +`./tools/run_tests/run_tests.py -h` ## Adding or removing source code @@ -46,7 +59,7 @@ Each language uses its own build system to work. Currently, the root's Makefile and the Visual Studio project files are building only the C and C++ source code. In order to ease the maintenance of these files, we have a template system. Please do not contribute manual changes to any of the generated -files. Instead, modify the template files, or the build.json file, and +files. Instead, modify the template files, or the build.yaml file, and re-generate the project files using the following command: `./tools/buildgen/generate_projects.sh` |