diff --git a/cmd/ractool/data.go b/cmd/ractool/data.go index 5e1a5f32..ec00c721 100644 --- a/cmd/ractool/data.go +++ b/cmd/ractool/data.go @@ -124,7 +124,7 @@ Installation: Like any other implemented-in-Go program, to install the ractool program: - go get github.com/google/wuffs/cmd/ractool + go install github.com/google/wuffs/cmd/ractool Extended Example: diff --git a/cmd/ractool/main.go b/cmd/ractool/main.go index f91ad533..6aaca3b9 100644 --- a/cmd/ractool/main.go +++ b/cmd/ractool/main.go @@ -125,7 +125,7 @@ Installation: Like any other implemented-in-Go program, to install the ractool program: - go get github.com/google/wuffs/cmd/ractool + go install github.com/google/wuffs/cmd/ractool Extended Example: diff --git a/doc/benchmarks.md b/doc/benchmarks.md index 97ac47a6..00b8e481 100644 --- a/doc/benchmarks.md +++ b/doc/benchmarks.md @@ -38,7 +38,7 @@ The output of those benchmark programs is compatible with the [benchstat](https://godoc.org/golang.org/x/perf/cmd/benchstat) tool. For example, that tool can calculate confidence intervals based on multiple benchmark runs, or calculate p-values when comparing numbers before and after a -code change. To install it, first install Go, then run `go get +code change. To install it, first install Go, then run `go install golang.org/x/perf/cmd/benchstat`. diff --git a/doc/getting-started.md b/doc/getting-started.md index 4fac53c7..b1e6c784 100644 --- a/doc/getting-started.md +++ b/doc/getting-started.md @@ -22,15 +22,25 @@ test suite, you might also have to install C compilers like clang and gcc, as well as C libraries (and their .h files) like libjpeg and libpng, as some tests compare that Wuffs produces exactly the same output as these other libraries. -Running `go get -v github.com/google/wuffs/cmd/...` will download and install -the Wuffs tools. Change `get` to `install` to re-install those programs without -downloading, e.g. after you've modified their source code, or after a manually -issued `git pull`. The Wuffs tools that you'll most often use are `wuffsfmt` +Run `git clone https://github.com/google/wuffs.git` to get the latest Wuffs +code, `cd` into its directory and run `go install -v ./cmd/wuffs*` to install +the Wuffs tools. The Wuffs tools that you'll most often use are `wuffsfmt` (analogous to `clang-format`, `gofmt` or `rustfmt`) and `wuffs` (roughly analogous to `make`, `go` or `cargo`). -You should now be able to run `wuffs test`. If all goes well, you should see -some output containing the word "PASS" multiple times. +You should now be able to run `wuffs test`. If you only have the `gcc` C +compiler installed, but not `clang`, then you can run `wuffs +test -ccompilers=gcc` instead. If all goes well, you should see some output +containing the word "PASS" multiple times. + +Remember to re-run `go install etc` whenever you've modified the Wuffs *tools'* +source code (i.e. `*.go` files) or after a manually issued `git pull`. If +you're only modifying the Wuffs *standard library's* source code (i.e. +`*.wuffs` files), re-running `go install etc` is unnecessary. + +If you're modifying just one particular codec in the standard library, such as +the `std/png/*.wuffs` files, then you can exclude unrelated tests by running +`wuffs test std/png`. ## Poking Around diff --git a/doc/spec/rac-spec.md b/doc/spec/rac-spec.md index 94a457d4..ac06ae78 100644 --- a/doc/spec/rac-spec.md +++ b/doc/spec/rac-spec.md @@ -661,7 +661,7 @@ Go programming language libraries: - [RAC](https://godoc.org/github.com/google/wuffs/lib/rac) - [RAC + Zlib](https://godoc.org/github.com/google/wuffs/lib/raczlib) -Command line tool, installable via `go get +Command line tool, installable via `go install github.com/google/wuffs/cmd/ractool`: - [ractool](https://godoc.org/github.com/google/wuffs/cmd/ractool) diff --git a/hello-wuffs-c/run.sh b/hello-wuffs-c/run.sh index ac3f9a6f..aa0ff8b3 100755 --- a/hello-wuffs-c/run.sh +++ b/hello-wuffs-c/run.sh @@ -18,7 +18,7 @@ CC=${CC:-gcc} # You may need to run -# go get github.com/google/wuffs/cmd/wuffs-c +# go install github.com/google/wuffs/cmd/wuffs-c # beforehand, to install the wuffs-c compiler. wuffs-c gen -package_name demo < parse.wuffs > parse.c diff --git a/script/bench-c-deflate-fragmentation.c b/script/bench-c-deflate-fragmentation.c index 73734d31..2adb6016 100644 --- a/script/bench-c-deflate-fragmentation.c +++ b/script/bench-c-deflate-fragmentation.c @@ -396,7 +396,7 @@ main(int argc, char** argv) { "compatible with the\n" "# https://godoc.org/golang.org/x/perf/cmd/benchstat tool. To install " "it, first\n" - "# install Go, then run \"go get golang.org/x/perf/cmd/benchstat\".\n"); + "# install Go, then run \"go install golang.org/x/perf/cmd/benchstat\".\n"); for (int i = 0; i < 5; i++) { msg = decode(true, true); diff --git a/script/bench-go-deflate/main.go b/script/bench-go-deflate/main.go index 8603f036..afe89e39 100644 --- a/script/bench-go-deflate/main.go +++ b/script/bench-go-deflate/main.go @@ -81,7 +81,7 @@ func main1() error { fmt.Printf("#\n") fmt.Printf("# The output format, including the \"Benchmark\" prefixes, is compatible with the\n") fmt.Printf("# https://godoc.org/golang.org/x/perf/cmd/benchstat tool. To install it, first\n") - fmt.Printf("# install Go, then run \"go get golang.org/x/perf/cmd/benchstat\".\n") + fmt.Printf("# install Go, then run \"go install golang.org/x/perf/cmd/benchstat\".\n") for i := -1; i < reps; i++ { for _, tc := range testCases { diff --git a/script/bench-go-gif/main.go b/script/bench-go-gif/main.go index 590ea2de..4dd74b2b 100644 --- a/script/bench-go-gif/main.go +++ b/script/bench-go-gif/main.go @@ -106,7 +106,7 @@ func main1() error { fmt.Printf("#\n") fmt.Printf("# The output format, including the \"Benchmark\" prefixes, is compatible with the\n") fmt.Printf("# https://godoc.org/golang.org/x/perf/cmd/benchstat tool. To install it, first\n") - fmt.Printf("# install Go, then run \"go get golang.org/x/perf/cmd/benchstat\".\n") + fmt.Printf("# install Go, then run \"go install golang.org/x/perf/cmd/benchstat\".\n") for i := -1; i < reps; i++ { for _, tc := range testCases { diff --git a/script/bench-go-png/main.go b/script/bench-go-png/main.go index f4625721..e6bd31c9 100644 --- a/script/bench-go-png/main.go +++ b/script/bench-go-png/main.go @@ -90,7 +90,7 @@ func main1() error { fmt.Printf("#\n") fmt.Printf("# The output format, including the \"Benchmark\" prefixes, is compatible with the\n") fmt.Printf("# https://godoc.org/golang.org/x/perf/cmd/benchstat tool. To install it, first\n") - fmt.Printf("# install Go, then run \"go get golang.org/x/perf/cmd/benchstat\".\n") + fmt.Printf("# install Go, then run \"go install golang.org/x/perf/cmd/benchstat\".\n") for i := -1; i < reps; i++ { for _, tc := range testCases { diff --git a/script/bench-rust-deflate/src/main.rs b/script/bench-rust-deflate/src/main.rs index f83a02db..84b2008e 100644 --- a/script/bench-rust-deflate/src/main.rs +++ b/script/bench-rust-deflate/src/main.rs @@ -47,7 +47,7 @@ fn main() { print!("#\n"); print!("# The output format, including the \"Benchmark\" prefixes, is compatible with the\n"); print!("# https://godoc.org/golang.org/x/perf/cmd/benchstat tool. To install it, first\n"); - print!("# install Go, then run \"go get golang.org/x/perf/cmd/benchstat\".\n"); + print!("# install Go, then run \"go install golang.org/x/perf/cmd/benchstat\".\n"); let mut dst = vec![0u8; 64 * 1024 * 1024]; diff --git a/script/bench-rust-gif/src/main.rs b/script/bench-rust-gif/src/main.rs index e7ca7373..a99db8cf 100644 --- a/script/bench-rust-gif/src/main.rs +++ b/script/bench-rust-gif/src/main.rs @@ -52,7 +52,7 @@ fn main() { print!("#\n"); print!("# The output format, including the \"Benchmark\" prefixes, is compatible with the\n"); print!("# https://godoc.org/golang.org/x/perf/cmd/benchstat tool. To install it, first\n"); - print!("# install Go, then run \"go get golang.org/x/perf/cmd/benchstat\".\n"); + print!("# install Go, then run \"go install golang.org/x/perf/cmd/benchstat\".\n"); let mut dst = vec![0u8; 64 * 1024 * 1024]; diff --git a/script/bench-rust-png/src/main.rs b/script/bench-rust-png/src/main.rs index 166b7f90..ca7be265 100644 --- a/script/bench-rust-png/src/main.rs +++ b/script/bench-rust-png/src/main.rs @@ -45,7 +45,7 @@ fn main() { print!("#\n"); print!("# The output format, including the \"Benchmark\" prefixes, is compatible with the\n"); print!("# https://godoc.org/golang.org/x/perf/cmd/benchstat tool. To install it, first\n"); - print!("# install Go, then run \"go get golang.org/x/perf/cmd/benchstat\".\n"); + print!("# install Go, then run \"go install golang.org/x/perf/cmd/benchstat\".\n"); let mut dst0 = vec![0u8; 64 * 1024 * 1024]; let mut dst1 = vec![0u8; 64 * 1024 * 1024]; diff --git a/test/c/testlib/testlib.c b/test/c/testlib/testlib.c index 3ebd2d8a..9b099cc5 100644 --- a/test/c/testlib/testlib.c +++ b/test/c/testlib/testlib.c @@ -422,7 +422,7 @@ test_main(int argc, char** argv, proc* tests, proc* benches) { "compatible with the\n" "# https://godoc.org/golang.org/x/perf/cmd/benchstat tool. To install " "it, first\n" - "# install Go, then run \"go get golang.org/x/perf/cmd/benchstat\".\n"); + "# install Go, then run \"go install golang.org/x/perf/cmd/benchstat\".\n"); } for (int i = 0; i < reps; i++) {