From f2bd7704334577da35aa795f81770186873789a6 Mon Sep 17 00:00:00 2001 From: Aaron Siddhartha Mondal Date: Thu, 14 Dec 2023 18:14:31 +0100 Subject: [PATCH] Fix pre-commit hooks after 378b806 (#482) Also fix some remaining `native-link` occurrences. --- nativelink-docs/README.md | 2 +- nativelink-docs/contributing.mdx | 2 +- nativelink-docs/introduction.mdx | 4 +- nativelink-docs/logo/dark.svg | 10 +-- nativelink-docs/logo/light.svg | 130 +++++++++++++++--------------- nativelink-docs/mint.json | 2 +- nativelink-docs/package-lock.json | 2 +- nativelink-docs/quickstart.mdx | 28 +++---- 8 files changed, 90 insertions(+), 90 deletions(-) diff --git a/nativelink-docs/README.md b/nativelink-docs/README.md index fcc891ddc..da2a522c8 100644 --- a/nativelink-docs/README.md +++ b/nativelink-docs/README.md @@ -1,4 +1,4 @@ -# NativeLink Docs +# NativeLink Docs ### Development diff --git a/nativelink-docs/contributing.mdx b/nativelink-docs/contributing.mdx index dcc6b8b50..b84bb1498 100644 --- a/nativelink-docs/contributing.mdx +++ b/nativelink-docs/contributing.mdx @@ -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. See Quickstart if having trouble running unit tests. diff --git a/nativelink-docs/introduction.mdx b/nativelink-docs/introduction.mdx index 95839cc4d..bd57df135 100644 --- a/nativelink-docs/introduction.mdx +++ b/nativelink-docs/introduction.mdx @@ -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). diff --git a/nativelink-docs/logo/dark.svg b/nativelink-docs/logo/dark.svg index 1a604f51c..5636bab00 100644 --- a/nativelink-docs/logo/dark.svg +++ b/nativelink-docs/logo/dark.svg @@ -22,21 +22,21 @@ - - - - - diff --git a/nativelink-docs/logo/light.svg b/nativelink-docs/logo/light.svg index 5774a821c..83f4c62ab 100644 --- a/nativelink-docs/logo/light.svg +++ b/nativelink-docs/logo/light.svg @@ -1,52 +1,52 @@ - - - - - - - - - - -]> - - - - - - - - - - - - - - - - - - - - - - - - +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 16.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) --> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd" [ + <!ENTITY ns_extend "http://ns.adobe.com/Extensibility/1.0/"> + <!ENTITY ns_ai "http://ns.adobe.com/AdobeIllustrator/10.0/"> + <!ENTITY ns_graphs "http://ns.adobe.com/Graphs/1.0/"> + <!ENTITY ns_vars "http://ns.adobe.com/Variables/1.0/"> + <!ENTITY ns_imrep "http://ns.adobe.com/ImageReplacement/1.0/"> + <!ENTITY ns_sfw "http://ns.adobe.com/SaveForWeb/1.0/"> + <!ENTITY ns_custom "http://ns.adobe.com/GenericCustomNamespace/1.0/"> + <!ENTITY ns_adobe_xpath "http://ns.adobe.com/XPath/1.0/"> +]> +<svg version="1.1" id="Layer_1" xmlns:x="&ns_extend;" xmlns:i="&ns_ai;" xmlns:graph="&ns_graphs;" + xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" width="38.399px" height="5.76px" + viewBox="0 0 38.399 5.76" enable-background="new 0 0 38.399 5.76" xml:space="preserve"> +<switch> + <foreignObject requiredExtensions="&ns_ai;" x="0" y="0" width="1" height="1"> + <i:pgfRef xlink:href="#adobe_illustrator_pgf"> + </i:pgfRef> + </foreignObject> + <g i:extraneous="self"> + <path fill-rule="evenodd" clip-rule="evenodd" fill="#7C54FF" d="M0.757,1.654h0.005c0.365,0,0.392,0.059,1.318,1.271 + c0.991,1.297,1.261,1.583,2.156,1.583h0.535V0.886H4.014V3.74H4.008c-0.392,0-0.456-0.084-1.318-1.276 + C1.773,1.199,1.509,0.886,0.534,0.886H0v3.622h0.757V1.654z"/> + <polygon fill-rule="evenodd" clip-rule="evenodd" fill="#7C54FF" points="12.012,4.508 11.153,4.508 11.153,1.479 9.464,1.479 + 9.464,0.817 13.706,0.817 13.706,1.479 12.012,1.479 "/> + <rect x="14.065" y="0.817" fill-rule="evenodd" clip-rule="evenodd" fill="#7C54FF" width="0.858" height="3.69"/> + <path fill-rule="evenodd" clip-rule="evenodd" fill="#7C54FF" d="M17.986,4.508h-0.57l-2.134-3.69h0.99l0.998,1.799 + c0.158,0.286,0.305,0.564,0.438,0.833h0.011l0.465-0.801l0.976-1.831h0.964L17.986,4.508z"/> + <polygon fill-rule="evenodd" clip-rule="evenodd" fill="#7C54FF" points="20.48,1.479 20.48,0.817 24.325,0.817 24.325,1.479 + 23.346,1.479 21.339,1.479 "/> + <polygon fill-rule="evenodd" clip-rule="evenodd" fill="#7C54FF" points="24.362,4.508 20.48,4.508 20.48,2.263 21.339,2.263 + 23.346,2.263 23.346,2.92 21.339,2.92 21.339,3.814 24.362,3.814 "/> + <polygon fill-rule="evenodd" clip-rule="evenodd" points="28.18,4.508 24.685,4.508 24.685,0.817 25.15,0.817 25.15,4.095 + 28.18,4.095 "/> + <rect x="28.539" y="0.817" fill-rule="evenodd" clip-rule="evenodd" width="0.466" height="3.69"/> + <path fill-rule="evenodd" clip-rule="evenodd" d="M33.459,4.519h0.393V0.828h-0.474v3.065v0.142c-1.742,0-1.571-3.207-3.621-3.207 + h-0.394v3.691h0.475V1.454V1.313C31.371,1.313,31.313,4.519,33.459,4.519z"/> + <polygon fill-rule="evenodd" clip-rule="evenodd" points="38.399,4.508 37.573,4.508 34.677,2.77 34.677,4.508 34.211,4.508 + 34.211,0.817 34.677,0.817 34.677,2.415 37.33,0.817 38.124,0.817 35.175,2.586 "/> + <path fill-rule="evenodd" clip-rule="evenodd" d="M6.96,4.508L7.565,5.76l0.604-1.252L7.846,4.262 + C7.758,4.339,7.662,4.379,7.565,4.384C7.468,4.379,7.371,4.339,7.283,4.262L6.96,4.508z"/> + <path fill-rule="evenodd" clip-rule="evenodd" fill="#7C54FF" d="M10.018,4.508H8.806V3.926L8.202,3.465 + c0.067-0.796-0.271-1.47-0.637-2.266C7.199,1.995,6.86,2.669,6.928,3.465L6.323,3.926v0.582H5.042L7.565,0L10.018,4.508z"/> + <circle fill-rule="evenodd" clip-rule="evenodd" cx="7.565" cy="2.782" r="0.281"/> + </g> +</switch> +<i:pgf id="adobe_illustrator_pgf"> + <![CDATA[ eJztfVlz6jrQ4DyfKv4DJCSBsHlhz8pOEpKQkH034CQEAsTAufd+D/PbR5I32ZZtGXzu3KmaOnUI yHK31Gq1ulvd0kao3UmU+pOumOCTTDDwa2OjIonCfCIVg6g4eDQaLWZzCRZFLqNBNptkYK3SUf5V qXkjSrPBZFxEz+Sndfh+pDKZzQfRYCQKi64G85EICs9KV0c3tWDr6OwEvMD8zaWD08Hf4mgWvMkn @@ -118,9 +118,9 @@ lYIP8CLYvVKncnSUz1RFOKcR5Nh+5i0XO7jppphU7DQRO/ic8/Abl969KPLagwvtG3qwwx9czcvV 90Jj2Fy/3BOq78z9vvaUi+1dZj9DUb65F0qkti4BmlBsf7gbip49FELxzwF49vaeDMUWxU4ofnpX DSWYU45J7d1HEP5MqBK9SM+42SloXXWYPjh/2+fLeT6ffch+P+wm3uqT3C3P9PWnTPNVrAA0krS/ 1y3Fp2fHhyeF2X6+uXubrE8e0jc16emBqT7U76/qe6W9Hrtdyo0VNHzYW+cg0eT+SVI6FL95OQol -8ol8KNZLdmC/8rCsFoq/9jOh6GA4CkXn5QHsXBTvXDp+yaTSnUsNtdx1pTdvGyOABg== - - +8ol8KNZLdmC/8rCsFoq/9jOh6GA4CkXn5QHsXBTvXDp+yaTSnUsNtdx1pTdvGyOABg== + + Vp0qI7J3n5ZJW57MzuRvyputGWhHFWC4G+bMVWA7pSfhMZ3kW/lFbL8R2tTpmkzN8g2Ahlvcv3VB SWPE9Dfvqzjcndmd9BytnsKmGhoIyA1ejj2k17jiNniNRdQ8x7A+X2erOlaAxoQ4c8EPJTusb9Lz z/zaBmulm70UEhwJK2SBWf6WtetuM13YKA3JWHfXNmdb4cmUhFVavCXDkW748glhVcYGQ8zUmYNd @@ -192,9 +192,9 @@ AnY+AEAvh41xCkeb6mjUFun9YX5q8qiA1699SscJyAcC2qljbvlopmQ0W10MS76gzilcuK1QXnIK u875N+sGH5d9jtyaU+Q9xakZhjZ9rtu16RDP9KLKqnKJvPcSltBvGL2eBD2Regwl3etpr3V6gOZm gtTkM4jpoLml6Dg1zLS9CqG52SH03dR9sn4QzTlx1SvR3E5rcCOaKX2nfHefMMZRNW3Td2jVXC0r AnqLKac9cd13ztsLaAdmuMAYrrk04o17YeHHG2mS47HqTd/swY+m0R1MPJ1HswdtYbgJCgsAs7D5 -aDof5YIPt4eUPUvGivsovTK0FpGtFIDJdrTeCDuSkow8W9vTniJu6bqkPR2SRQC65A== - - +aDof5YIPt4eUPUvGivsovTK0FpGtFIDJdrTeCDuSkow8W9vTniJu6bqkPR2SRQC65A== + + OuMNXgOHFIIiOjD50kg0mAflxRS1zzUykd6RoV1SoJwT9QwCKKCdqEzKrpvNbdd4T3raEeqNT3P/ 68g094l6Gh2pKH1BJiXcGg8NM9hS/vCBbjdqkZCUzSK0iaNoEx6o7JQK58l745zsl/aJVO65uE7N MnpvklbvzfexrffGjtNsvDfHS3pvTMKGPQn7473hw8XkJpWXg8J7c+xLcBKAEfEhf7HR/nbYYafP @@ -266,9 +266,9 @@ IKoLD53NboTGjwsPnW87dDNx6VP1HW87DGAXPa904aG346aWvvDQlBxp2hILLJmLa7nwcNlcXI8X HjpAYdfuV47oUi88tPGDK4E6agDMyhceUp0Sv/qFh85uMKOwWeHCQ1Iam26MkZa1pS48dLbulUDl 1S88dLbuLdNz2QsPSUSjDbj0cOEhre254oWHdCGKK194aNEYDbcd6mhWvPBQG1zibYdYAMxqFx46 J+nqu7grXnjovOODE22lCw+NDTP7M5fXbEwXHjrvTARcjjSivvDQ+bbDgHzW0OoXHqptIifpKjvs -3k92SRHWigfbtUKOgTq/pjmZdb/xaTkdEpXZ74Wq8f4B6x2ShDxKE1fJZNFdXvt7Uw== - - +3k92SRHWigfbtUKOgTq/pjmZdb/xaTkdEpXZ74Wq8f4B6x2ShDxKE1fJZNFdXvt7Uw== + + TAArqpyCK2Ja1t6SE502TOpczGojfWYwWFszSeJmnyGwzByHYo9nYSZ1N8zJVWBWVyh8un+UZCLj UKr3OE3z0ucxDO3dHz0XLq63I4nv6Fb5p8w0P85K6z+Lcjb0JPR58O3tMJzfWdQ2T89/LjM/w/vH XCaZ7uVP63fJk6QUyrQa6bfy5fD6oN85zd5+XolnmZ+biPgevi1F09WvtatL6IceFke7dxPxIDL+ @@ -340,9 +340,9 @@ RWlzRbXeLJcuSpsrCt3d3tJF4VEQJv+jLBn27iPy5Kk9lSIoM1AlJDpfQKkF81QUCZWO6BJKkylb 8BqSH2hBwu3wZhTNG2jLoZ/g436SlCXT1mHoGXlUoIEUR5f+wo2V58XuUWpwN0/K3DqIF2Mos5UP 79SOScelIIeMmtapfMAH10rC6H4uqondZyQtkYTe34upjT5RBADQppOywNKyMbnyw/WBwun7LYbJ dE8OYtbU96yWjbmt9TAq7xE8lZQRaVSQSI6i09DAzyO5Flx5vuSUUCC1WFlq6cD11Hft/I7/vR/4 -lWdzXDITzLP5PPiTulyMROlcGnwMxkFAxZ3Ar1TpiGWvx/1JXRLFK/HveXXSW3yL4w== - - +lWdzXDITzLP5PPiTulyMROlcGnwMxkFAxZ3Ar1TpiGWvx/1JXRLFK/HveXXSW3yL4w== + + ebAYTJU6laOjfKYq9iZ9MShfpZZ5y2GeELnJSnQBfuqIIexAlhnV90Jj2Fy/3BOq78z9vjkoIco3 91C2J4w4iO0Pd+VMpvjn4BPGHiRDsUWxAxOVqqEEc8rJDjrCkS5YYMdD9vthN/FWn+RueaaPz0Y5 OBgoPnvdUnx6dnx4Upjt55u7t8n65CF9U5OeHpjqQ/3+qr5X2ushbqBOfdXPLjGcmm9I09qEGa5p @@ -396,7 +396,7 @@ h7Jojcmm82mlLFtgkDKTBWpNBjS8wKNpwSYB9cH6ofVfVW1Q/+WvWqVsMp9l+IwOBnSWy8lak4wL EYDneDj0WJu0MqztmSSTBkLZNHRyKxi0tJmJ4F0Ca70CHIfkFGKjHAff18o0fgG94rJADmMFAG0u DZU4rKzAgxEMamCAfpvlCgWdgmoBeivNFNg8XklmGB2K+hvDpBaprVFg6O01daqH6NIqK+YLsGaQ gZGAGQwbbeFDvJKEwQhaMx8z4bcYFMbjyVyYi1PwKPghibP5RBKDs8/JX7AEvqS9AGyj83rg1/8B -0MraUw== - - - +0MraUw== + ]]> + + diff --git a/nativelink-docs/mint.json b/nativelink-docs/mint.json index 467ce1bd7..b51d5b818 100644 --- a/nativelink-docs/mint.json +++ b/nativelink-docs/mint.json @@ -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" } diff --git a/nativelink-docs/package-lock.json b/nativelink-docs/package-lock.json index c370fb33f..77104ba1d 100644 --- a/nativelink-docs/package-lock.json +++ b/nativelink-docs/package-lock.json @@ -1,5 +1,5 @@ { - "name": "native-link-docs", + "name": "nativelink-docs", "lockfileVersion": 3, "requires": true, "packages": { diff --git a/nativelink-docs/quickstart.mdx b/nativelink-docs/quickstart.mdx index 7324688ee..7aced3502 100644 --- a/nativelink-docs/quickstart.mdx +++ b/nativelink-docs/quickstart.mdx @@ -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 @@ -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 @@ -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). @@ -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 ``` 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. @@ -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`. ``` 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. @@ -217,10 +217,10 @@ cosign verify ghcr.io/tracemachina/nativelink:${PINNED_TAG} \ --certificate-oidc-issuer=https://token.actions.githubusercontent.com ``` - - 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. + + 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.