Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dev: update README #71113

Merged
merged 1 commit into from
Oct 5, 2021
+9 −23
Merged

dev: update README #71113

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 9 additions & 23 deletions pkg/cmd/dev/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@
WARNING: `dev` isn't feature-complete, and the migration to Bazel at Cockroach
is still in-progress. Proceed at your own risk :)
WARNING: The migration to Bazel at Cockroach is still in-progress.
Proceed at your own risk :)

Dev is a general-purpose dev tool for folks working on `cockroach`.
`dev` is a general-purpose tool for folks working on `cockroach`. Unlike
builds and tests performed w/ `make`, everything `dev` does is driven by
Bazel as a build system.

$ dev -h
<...>
Usage:
dev [command]
You can use the script `./dev` at top-level instead of building `dev`
ahead of time. This script just builds `dev` and immediately runs it
with the supplied arguments.

Available Commands:
bench Run the specified benchmarks
build Build the specified binaries
generate Generate the specified files
lint Run the specified linters
test Run the specified tests

Flags:
-h, --help help for dev
-v, --version version for dev

Use "dev [command] --help" for more information about a command.

To update the testdata files:

$ go test -run TestDatadriven -rewrite [-record] [-from-checkout=<path-to-crdb-checkout>]
Run `./dev help` to see what `dev` can do!