diff options
author | 2015-08-31 09:56:40 +0000 | |
---|---|---|
committer | 2015-08-31 19:13:29 +0000 | |
commit | a807ad6339c1564fc2bace7a874b0b78ee99e240 (patch) | |
tree | fa430ef5eb63d76869ad41c0c631e4c1ec55a720 | |
parent | 321ff5daf582775d58ba9ed40d38f22a096fe343 (diff) |
Fix small issues in contributing.md.
--
MOS_MIGRATED_REVID=101919009
-rw-r--r-- | site/contributing.md | 31 |
1 files changed, 15 insertions, 16 deletions
diff --git a/site/contributing.md b/site/contributing.md index e02b8e873c..214b00710f 100644 --- a/site/contributing.md +++ b/site/contributing.md @@ -34,7 +34,7 @@ a lot of time in a patch. line. </ul> The HTTP password required by Gerrit can be obtained from your - <a href="https://bazel-review.googlesource.com/#/settings/http-password">Gerrit settngs page</a>. + <a href="https://bazel-review.googlesource.com/#/settings/http-password">Gerrit settings page</a>. See the <a href="https://gerrit-review.googlesource.com/Documentation/user-upload.html">Gerrit documentation</a> for more information about uploading changes. @@ -47,11 +47,6 @@ a lot of time in a patch. is closed. </ol> -We will make changes to this process as necessary, and we're hoping to move -closer to a fully open development model in the future (also see -[Is Bazel developed fully in the open?](governance.html#isbazelopen)). - - ## Setting up your coding environment _Note that some of our tests target Java 8 so you must test using a JDK 8._ @@ -77,26 +72,29 @@ the folder as a project in IntelliJ. <a name="compile-bazel"></a> ### Compiling Bazel -To test out bazel, you need to compile it. There is currently two ways of +To test out bazel, you need to compile it. There are currently two ways of compiling it: -* `sh compile.sh` build a Bazel binary without Bazel, it should only be used to - bootstrap Bazel itself. The resulting binary can be found at `output/bazel`. +* `sh compile.sh` bootstraps Bazel from scratch, first compiling it without using + Bazel, then rebuilding it again using the just built Bazel and optionally runs + tests, too. The resulting binary can be found at `output/bazel`. * `bazel build //src:bazel` builds the Bazel binary using Bazel and the - resulting binary can be found at `bazel-bin/src/bazel`. + resulting binary can be found at `bazel-bin/src/bazel`. This is the recommended + way of rebuilding Bazel once you have bootstrapped it. In addition to the Bazel binary, you might want to build the various tools Bazel uses. They are located in `//src/java_tools`, `//src/objc_tools` and -`//src/tools` and contains README files describing their respective -utility. +`//src/tools` and their directories contain README files describing their +respective utility. When modifying Bazel, you want to make sure that the following still works: * Bootstrap test with `sh compile.sh all` after having removed the `output` directory: it rebuilds Bazel with `./compile.sh`, Bazel with the `compile.sh` Bazel and Bazel with the Bazel-built binary. It compares if the - constructed Bazel builts are identical and then run all bazel tests with - `bazel test //src/... //third_party/ijar/...`. + constructed Bazel builts are identical and then runs all bazel tests with + `bazel test //src/... //third_party/ijar/...`. This is what we use at Google + to ensure that we don't break Bazel when pushing new commits, too. ### Debugging Bazel @@ -112,8 +110,8 @@ build:debug --strip="never" Then you can rebuild Bazel with `bazel build --config debug //src:bazel` and use your favorite debugger to start debugging. -For debugging the C++ client you can just fire it from gdb or lldb as you normally would. -But if you want to debug the Java code, you must attach to the server with the following: +For debugging the C++ client you can just run it from gdb or lldb as you normally would. +But if you want to debug the Java code, you must attach to the server using the following: * Run Bazel with debugging option `--host_jvm_debug` before the command (e.g., `bazel --batch --host_jvm_debug build //src:bazel`). @@ -121,6 +119,7 @@ But if you want to debug the Java code, you must attach to the server with the f run `jdb -attach localhost:5005`. From within Eclipse, use the [remote Java application launch configuration](http://help.eclipse.org/luna/index.jsp?topic=%2Forg.eclipse.jdt.doc.user%2Ftasks%2Ftask-remotejava_launch_config.htm). + For IntelliJ, you can refer to [Run/Debug Configuration: Remote](https://www.jetbrains.com/idea/help/run-debug-configuration-remote.html). ## Bazel's code description |