Skip to content

Commit

Permalink
Fix pre-commit hooks after 378b806 (#482)
Browse files Browse the repository at this point in the history
Also fix some remaining `native-link` occurrences.
  • Loading branch information
aaronmondal committed Dec 14, 2023
1 parent 449376b commit f2bd770
Show file tree
Hide file tree
Showing 8 changed files with 90 additions and 90 deletions.
2 changes: 1 addition & 1 deletion nativelink-docs/README.md
@@ -1,4 +1,4 @@
# NativeLink Docs
# NativeLink Docs

### Development

Expand Down
2 changes: 1 addition & 1 deletion nativelink-docs/contributing.mdx
Expand Up @@ -52,7 +52,7 @@ efforts from contributors on the same issue.

- Add tests relevant to the fixed bug or new feature.

- Unit-tests run with `bazel test //..` must pass locally.
- Unit-tests run with `bazel test //..` must pass locally.

<Note>See Quickstart if having trouble running unit tests.</Note>

Expand Down
4 changes: 2 additions & 2 deletions nativelink-docs/introduction.mdx
Expand Up @@ -16,8 +16,8 @@ description: 'What is NativeLink?'

Native link is an extremely (blazingly?) fast and efficient build cache and
remote executor for systems that communicate using the [Remote execution
protocol](https://github.com/bazelbuild/remote-apis/blob/main/build/bazel/remote/execution/v2/remote_execution.proto)
such as [Bazel](https://bazel.build), [Buck2](https://buck2.build),
protocol](https://github.com/bazelbuild/remote-apis/blob/main/build/bazel/remote/execution/v2/remote_execution.proto)
such as [Bazel](https://bazel.build), [Buck2](https://buck2.build),
[Goma](https://chromium.googlesource.com/infra/goma/client/) and
[Reclient](https://github.com/bazelbuild/reclient).

Expand Down
10 changes: 5 additions & 5 deletions nativelink-docs/logo/dark.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
130 changes: 65 additions & 65 deletions nativelink-docs/logo/light.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion nativelink-docs/mint.json
Expand Up @@ -47,7 +47,7 @@
}
],
"footerSocials": {
"github": "https://github.com/TraceMachina/native-link",
"github": "https://github.com/TraceMachina/nativelink",
"website": "https://tracemachina.com/",
"twitter": "https://twitter.com/tracemachina"
}
Expand Down
2 changes: 1 addition & 1 deletion nativelink-docs/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 14 additions & 14 deletions nativelink-docs/quickstart.mdx
Expand Up @@ -40,7 +40,7 @@ bazel --version
```

```shell Docker-ARM
docker run -it --name=NL -v $(pwd):/native-link ubuntu:latest
docker run -it --name=NL -v $(pwd):/nativelink ubuntu:latest

# If above has already been run or trying to start in new terminal:
docker exec -it NL bash
Expand All @@ -64,7 +64,7 @@ bazel --version
```

```shell Docker-x86
docker run -it --name=NL -v $(pwd):/native-link ubuntu:latest
docker run -it --name=NL -v $(pwd):/nativelink ubuntu:latest

# If above has already been run or trying to start in new terminal:
docker exec -it NL bash
Expand Down Expand Up @@ -104,7 +104,7 @@ bazel --version
### Compile and Run NativeLink Server

The following command will allow you to compile and run the NativeLink server for the first time.

```shell
apt install -y gcc g++ lld python3
# Install cargo (if needed).
Expand All @@ -113,17 +113,17 @@ The following command will allow you to compile and run the NativeLink server fo

# Run with Cargo:
# Unoptimized development build
cargo run --bin cas -- ./native-link-config/examples/basic_cas.json
cargo run --bin cas -- ./nativelink-config/examples/basic_cas.json

# Optimized release build
cargo run --release --bin cas -- ./native-link-config/examples/basic_cas.json
cargo run --release --bin cas -- ./nativelink-config/examples/basic_cas.json

# Run with Bazel:
# Unoptimized development build on Unix.
bazel run cas -- ./native-link-config/examples/basic_cas.json
bazel run cas -- ./nativelink-config/examples/basic_cas.json

# Optimized release build on Unix.
bazel run -c opt cas -- ./native-link-config/examples/basic_cas.json
bazel run -c opt cas -- ./nativelink-config/examples/basic_cas.json
```

<Note>The `--release` flag causes link-time-optmization to be enabled, which can take a while to compile, but will result in a much faster binary.</Note>
Expand All @@ -138,7 +138,7 @@ bazel test //... \
--remote_executor=grpc://127.0.0.1:50051 \
--remote_default_exec_properties=cpu_count=1

# This causes bazel to run the commands through an all-in-one `CAS`, `scheduler`
# This causes bazel to run the commands through an all-in-one `CAS`, `scheduler`
# and `worker`.
```
<Note>If the NativeLink server was run in a docker container, the above command for starting the NativeLink client will need to be run in the same container as the server in order to connect.</Note>
Expand Down Expand Up @@ -217,10 +217,10 @@ cosign verify ghcr.io/tracemachina/nativelink:${PINNED_TAG} \
--certificate-oidc-issuer=https://token.actions.githubusercontent.com
```
<Tip>
The images are reproducible on `X86_64-unknown-linux-gnu`. If you're on
such a system you can produce a binary-identical image by building the
`.#image` flake output locally. Make sure that your `git status` is
completely clean and aligned with the commit you want to reproduce.
Otherwise the image will be tainted with a `"dirty"` revision label.
<Tip>
The images are reproducible on `X86_64-unknown-linux-gnu`. If you're on
such a system you can produce a binary-identical image by building the
`.#image` flake output locally. Make sure that your `git status` is
completely clean and aligned with the commit you want to reproduce.
Otherwise the image will be tainted with a `"dirty"` revision label.
</Tip>

0 comments on commit f2bd770

Please sign in to comment.