Skip to content
Permalink
Browse files

Fix incorrect paths in docs.

PiperOrigin-RevId: 284995546
Change-Id: I53cf558b600a339c3a98e545fa86371069ef9d97
  • Loading branch information
timford committed Dec 11, 2019
1 parent bbb5f12 commit 3b8e8b595c1830553bda904f8599ef0ef71ac366
Showing with 33 additions and 33 deletions.
  1. +3 −3 docs/ANALYZERS.md
  2. +13 −13 docs/BUILDING.md
  3. +8 −8 docs/GUIDE.md
  4. +4 −4 docs/STORAGE_LIBRARY.md
  5. +2 −2 docs/WDA_ANALYZER.md
  6. +3 −3 go/internal/quickstore_microservice/BUILD
@@ -14,9 +14,9 @@ analyzer types are described below.
## Configuring analyzers

Analyzers are configured in the
[`QuickstoreInput`](../quickstore/quickstore.proto) argument to
the Quickstore constructor ([C++](../quickstore/cxx/quickstore.h),
[Go](../quickstore/go/quickstore.go)).
[`QuickstoreInput`](../proto/quickstore/quickstore.proto) argument to
the Quickstore constructor ([C++](../cxx/quickstore/quickstore.h),
[Go](../go/quickstore/quickstore.go)).

Here's a simple example:

@@ -50,7 +50,7 @@ cc_library(
srcs = ["use_mako.cc"],
hdrs = ["use_mako.h"],
deps = [
"@mako//helpers/cxx/quickstore",
"@mako//cxx/quickstore",
],
)
```
@@ -62,7 +62,7 @@ go_library(
srcs = ["usemako.go"],
importpath = "github.com/your/project/usemako"
deps = [
"@mako//helpers/go/quickstore",
"@mako//go/quickstore",
],
)
```
@@ -79,8 +79,8 @@ Regardless of the tool you use, when you import Mako from your `.go` files it
will look roughly like this:
```go
import (
"github.com/google/mako/quickstore/go/quickstore"
qpb "github.com/google/mako/quickstore/quickstore_proto"
"github.com/google/mako/go/quickstore"
qpb "github.com/google/mako/proto/quickstore/quickstore_go_proto"
)
```

@@ -94,30 +94,30 @@ Quickstore test.
## Building the command-line tool

```bash
$ bazel build internal/tools/cli:mako
$ bazel build cli:mako
```

The binary will be found in `bazel-bin/internal/tools/cli/*/mako` (the wildcard
The binary will be found in `bazel-bin/cli/*/mako` (the wildcard
will differ based on your platform, check the Bazel output). You can copy this
binary into a more convenient location (e.g. somewhere on your $PATH).
Alternatively, run directly from Bazel:

```bash
$ bazel run internal/tools/cli:mako help
$ bazel run cli:mako help
```

## Building the Quickstore microservice
```bash
$ bazel build internal/quickstore_microservice:quickstore_microservice_mako
$ bazel build go/internal/quickstore_microservice:quickstore_microservice_mako
```

The binary will be found in
`bazel-bin/internal/quickstore_microservice/quickstore_microservice_mako`. You
`bazel-bin/go/internal/quickstore_microservice/quickstore_microservice_mako`. You
can copy this binary into a more convenient location (e.g. somewhere on your
$PATH). Alternatively, run directly from Bazel:

```bash
$ bazel run internal/quickstore_microservice:quickstore_microservice_mako
$ bazel run go/internal/quickstore_microservice:quickstore_microservice_mako
```

### Microservice Docker image
@@ -130,19 +130,19 @@ The Quickstore microservice can also be built into a Docker image:
> microservice in Linux.
```bash
$ bazel build internal/quickstore_microservice:quickstore_microservice_mako_image.tar
$ bazel build go/internal/quickstore_microservice:quickstore_microservice_mako_image.tar
```

This image can then be loaded into a Docker client for running:

```bash
$ docker load -i bazel-bin/internal/quickstore_microservice/quickstore_microservice_mako_image.tar
$ docker load -i bazel-bin/go/internal/quickstore_microservice/quickstore_microservice_mako_image.tar
```

The container can then be run:

```bash
$ docker run <docker arguments> bazel/internal/quickstore_microservice:quickstore_microservice_mako_image
$ docker run <docker arguments> bazel/go/internal/quickstore_microservice:quickstore_microservice_mako_image
```

Read more at
@@ -70,8 +70,8 @@ Mako runs can have a diverse set of metadata associated with them, including:

When using Quickstore, this data is populated via the `QuickstoreInput` object
passed to the Quickstore client
constructors ([C++](../helpers/cxx/quickstore/quickstore.go),
[Go](../helpers/cxx/quickstore/quickstore.h)). See the comments on
constructors ([C++](../cxx/quickstore/quickstore.h),
[Go](../go/quickstore/quickstore.go)). See the comments on
`QuickstoreInput` in
[quickstore.proto](../proto/quickstore/quickstore.proto) for the full
set of supported run metadata information.
@@ -101,7 +101,7 @@ To create the benchmark you’ll use the Mako command-line tool. Visit
the command-line tool.

```bash
$ alias mako=<your mako directory>/bazel-bin/internal/tools/cli/mako
$ alias mako=<your mako directory>/bazel-bin/cli/mako
```

You can see all the CLI commands using the ‘help’ subcommand:
@@ -214,7 +214,7 @@ import (
"context"
"fmt"
"testing"
"github.com/google/mako/helpers/go/quickstore"
"github.com/google/mako/go/quickstore"
qpb "github.com/google/mako/proto/quickstore/quickstore_go_proto"
)
@@ -259,7 +259,7 @@ listen for client connections:

```bash
$ MAKO_PORT=9347 # could be any port
$ bazel run internal/quickstore_microservice:quickstore_microservice_mako -- --addr="localhost:${MAKO_PORT}"
$ bazel run go/internal/quickstore_microservice:quickstore_microservice_mako -- --addr="localhost:${MAKO_PORT}"
```

Note that this command will fail if you haven’t set up authentication as
@@ -283,7 +283,7 @@ pushed to a repository:
> microservice in Linux.
```bash
$ bazel build internal/quickstore_microservice:quickstore_microservice_mako_image.tar
$ bazel build go/internal/quickstore_microservice:quickstore_microservice_mako_image.tar
```

Documentation about the Docker Bazel rules can be found at
@@ -292,7 +292,7 @@ https://github.com/bazelbuild/rules_docker#using-with-docker-locally.
To load the tar file output by the above command as a local Docker container:

```bash
$ docker load -i bazel-bin/internal/quickstore_microservice/quickstore_microservice_mako_image.tar
$ docker load -i bazel-bin/go/internal/quickstore_microservice/quickstore_microservice_mako_image.tar
```

The image is loaded and ready to run. Inside the container, the microservice
@@ -308,7 +308,7 @@ The full `docker run` command will look something like:

```bash
$ MAKO_PORT=9347 # could be any port
$ docker run --rm -v ~/.config/gcloud/application_default_credentials.json:/root/adc.json -e "GOOGLE_APPLICATION_CREDENTIALS=/root/adc.json" -p ${MAKO_PORT}:9813 bazel/internal/quickstore_microservice:quickstore_microservice_mako_image
$ docker run --rm -v ~/.config/gcloud/application_default_credentials.json:/root/adc.json -e "GOOGLE_APPLICATION_CREDENTIALS=/root/adc.json" -p ${MAKO_PORT}:9813 bazel/go/internal/quickstore_microservice:quickstore_microservice_mako_image
```

As mentioned above, you will need to arrange for the microservice image to be
@@ -30,10 +30,10 @@ The following operations can be performed on objects of the above types:
> **NOTE**: Comprehensive documentation for each method is available in the
> source files for the interface types.
> * For the C++ storage library
> [mako_client.h](../clients/cxx/storage/mako_client.h), see the per-method
> documentation in [storage.h](../spec/cxx/storage.h).
> * For the Go storage library [mako.go](../clients/go/storage/mako.go), see the
> per-method documentation in [storage.go](../spec/go/storage.go).
> [mako_client.h](../cxx/clients/storage/mako_client.h), see the per-method
> documentation in [storage.h](../cxx/spec/storage.h).
> * For the Go storage library [mako.go](../go/clients/storage/mako/mako.go), see the
> per-method documentation in [storage.go](../go/spec/storage.go).
## Language and build system support

@@ -135,8 +135,8 @@ size is:
The most convenient way to specify your queries is to provide a single query
that minimally sets the `RunInfoQuery.benchmark_key` and `RunInfoQuery.limit`
fields. You can create more complex queries you need them. We recommend that you
use [tags](/testing/performance/mako/g3doc/guide/tags.md) for these queries
to help isolate environments under analysis.
use [tags](CONCEPTS.md#tags) for these queries to help isolate environments
under analysis.
For example, with these configurations:
@@ -67,9 +67,9 @@ cc_binary(
# Therefore, to load this Docker image, you must instead use `bazel build` to build a tar file that
# can be loaded into Docker. e.g.
#
# $ bazel build //internal/quickstore_microservice:quickstore_microservice_mako_image.tar
# $ docker load -i bazel-bin/internal/quickstore_microservice/quickstore_microservice_mako_image.tar
# $ docker run <docker arguments> bazel/internal/quickstore_microservice:quickstore_microservice_mako_image
# $ bazel build //go/internal/quickstore_microservice:quickstore_microservice_mako_image.tar
# $ docker load -i bazel-bin/go/internal/quickstore_microservice/quickstore_microservice_mako_image.tar
# $ docker run <docker arguments> bazel/go/internal/quickstore_microservice:quickstore_microservice_mako_image
#
# See an example of a full command-line at
# https://github.com/google/mako/blob/master/docs/GUIDE.md#quickstore-microservice-as-a-docker-image.

0 comments on commit 3b8e8b5

Please sign in to comment.
You can’t perform that action at this time.