TBR: docs: Replace "v23" (the tool name) with "jiri".
Change-Id: If5ae00e09842f4cad011c94d606a68db51c3403f
MultiPart: 2/17
diff --git a/community/contributing.md b/community/contributing.md
index 6aef95e..ae49fd4 100644
--- a/community/contributing.md
+++ b/community/contributing.md
@@ -60,7 +60,7 @@
To contribute to Vanadium, you will want to setup up a directory which
contains the entire collection of repositories (projects) which make up the
Vanadium universe of language libraries, command line tools, services,
-website, example projects, and development tools like [v23].
+website, example projects, and development tools like [jiri].
#### JIRI_ROOT environment variable
@@ -93,22 +93,22 @@
#### REQUIRED: profile installation
-Extra development profiles such as ARM cross-compilation, support for mobile, or web development can be installer using the `v23` command. To see a list of available profiles run:
+Extra development profiles such as ARM cross-compilation, support for mobile, or web development can be installer using the `jiri` command. To see a list of available profiles run:
```bash
-v23 profile list
+jiri profile list
```
-Profiles can be installed with `v23 profile install <profile>` where `<profile>` is replaced with one of the items from the list.
+Profiles can be installed with `jiri profile install <profile>` where `<profile>` is replaced with one of the items from the list.
-Invocations of the `v23 profile install` command are idempotent.
+Invocations of the `jiri profile install` command are idempotent.
##### syncbase profile
In order to successfully install/build the Vanadium Go code you will need to install syncbase dependencies with:
```bash
-v23 profile install syncbase
+jiri profile install syncbase
```
**The syncbase profile is required.**
@@ -120,7 +120,7 @@
In order to install the nodejs profile run:
```bash
-v23 profile install nodejs
+jiri profile install nodejs
```
## Development
@@ -133,13 +133,13 @@
```bash
# For the host OS and architecture
-v23 go <command> <packages>
+jiri go <command> <packages>
# For cross-compilation using default toolchain
-GOARCH=<arch> GOOS=<os> v23 go <command> <packages>
+GOARCH=<arch> GOOS=<os> jiri go <command> <packages>
# For cross-compilation using development profiles
-V23_PROFILE=<profile> v23 go <command> <packages>
+V23_PROFILE=<profile> jiri go <command> <packages>
```
These commands setup the `GOPATH` and other environment variables so the
@@ -150,26 +150,26 @@
Check that the Go code builds
```bash
-v23 go build v.io/...
+jiri go build v.io/...
```
Run all Go tests
```bash
-v23 go test v.io/...
+jiri go test v.io/...
```
Install all the Go binaries
```bash
-v23 go install v.io/...
+jiri go install v.io/...
```
#### JavaScript
Ensure that you have the required profile set up by running:
- v23 profile install nacl nodejs
+ jiri profile install nacl nodejs
This will install dependencies needed to build and run the Vanadium JavaScript
projects and the [Vanadium Chrome extension]. Darwin (OS X) users should be sure
@@ -184,7 +184,7 @@
Build the Go Vanadium binaries.
```bash
-v23 go install v.io/...
+jiri go install v.io/...
```
All other dependencies can be satisfied via the default `make` target.
@@ -210,22 +210,25 @@
"master" branch of each local repository is reserved for tracking the remote
https://vanadium.googlesource.com counterpart. All Vanadium development should
take place on a non-master (feature) branch. Once your code has been reviewed
-and approved, it will be merged into the remote master via our code review system and brought to your local instance via `v23 update`.
+and approved, it will be merged into the remote master via our code review
+system and brought to your local instance via `jiri update`.
**The only way to contribute to master is via the Gerrit code review process.**
-To submit a change for review you will need to squash your feature branch into a single commit and send the patch to Gerrit for review. The command `v23 cl` simplifies this process and is described in greater detail below.
+To submit a change for review you will need to squash your feature branch into
+a single commit and send the patch to Gerrit for review. The command `jiri cl`
+simplifies this process and is described in greater detail below.
#### Creating a change
1. Sync the master branch to the latest version of the project:
- v23 update
+ jiri update
2. Create a new branch for your change
# replacing `<branch>` with your branch name
- v23 cl new <branch>
+ jiri cl new <branch>
3. Make modifications to the project source code.
4. Stage any changed files for a commit:
@@ -240,9 +243,9 @@
#### Syncing a change to the latest version of the project
-1. Update all of the local master branches using the `v23` command:
+1. Update all of the local master branches using the `jiri` command:
- v23 update
+ jiri update
2. If you are not already on it, switch to the feature branch that corresponds
to the change you are trying to bring up to date with the upstream:
@@ -262,11 +265,11 @@
git checkout <branch>
-2. Submit your change to Gerrit with the `v23 cl` command.
+2. Submit your change to Gerrit with the `jiri cl` command.
# <reviewers> is a comma-seperated list of emails or LDAPs
# Alternatively reviewers can be added via the Gerrit UI
- v23 cl mail -r=<reviewers>
+ jiri cl mail -r=<reviewers>
If you are unsure who to add as a reviewer you can leave off the `-r` flag. Our team periodically scans for CLs and a reviewer will come along. If you would rather not wait, feel free to let us know about your change by filing an issue on GitHub.
@@ -291,7 +294,7 @@
5. Once you have addressed all review comments, you can update the change with
a new patch using:
- v23 cl mail
+ jiri cl mail
#### Submitting a change
@@ -300,13 +303,13 @@
it. You will need to follow the steps in the section above: ["Syncing a
change to the latest version of the
project"](#syncing-a-change-to-the-latest-version-of-the-project) and then
- run `v23 cl mail` again
+ run `jiri cl mail` again
2. The reviewer will submit your change and it will be merged into the master
branch.
3. Optional: Delete the feature branch once it has been submitted:
git checkout master
- v23 cl cleanup <branch>
+ jiri cl cleanup <branch>
#### Useful shortcuts
@@ -324,7 +327,7 @@
[brew]: http://brew.sh/
[gerrit]: https://vanadium-review.googlesource.com
[Vanadium Chrome extension]: ../tools/vanadium-chrome-extension.md
-[v23]: ../tools/v23.md
+[jiri]: ../tools/jiri.md
[cla]: https://cla.developers.google.com/about/google-individual?csw=1
[corp-cla]: https://cla.developers.google.com/about/google-corporate?csw=1
[issue tracker]: https://github.com/vanadium/issues/issues
diff --git a/tools/jiri.md b/tools/jiri.md
new file mode 100644
index 0000000..6b9eb32
--- /dev/null
+++ b/tools/jiri.md
@@ -0,0 +1,9 @@
+# jiri
+
+`jiri` is a multi-purpose command-line tool designed to aid Vanadium
+development. After following the setup instructions for [contributing] you
+will have the `jiri` tool in your `PATH` and can run:
+
+ jiri help
+
+[contributing]: ../community/contributing.md
diff --git a/tools/v23.md b/tools/v23.md
deleted file mode 100644
index e5ce80e..0000000
--- a/tools/v23.md
+++ /dev/null
@@ -1,9 +0,0 @@
-# v23
-
-`v23` is a multi-purpose command-line tool designed to aid Vanadium
-development. After following the setup instructions for [contributing] you
-will have the `v23` tool in your `PATH` and can run:
-
- v23 help
-
-[contributing]: ../community/contributing.md
