From 4dbf1de6ba81d1c4a07f25365274192550079969 Mon Sep 17 00:00:00 2001 From: Emil Ernerfeldt Date: Wed, 10 Jul 2024 11:21:33 +0200 Subject: [PATCH] Add `-e cpp` to all invocations of `pixi run cpp-*` --- .github/workflows/contrib_checks.yml | 12 ++++++------ .github/workflows/cpp_matrix_full.json | 2 +- .github/workflows/reusable_checks_cpp.yml | 16 ++++++++-------- .github/workflows/reusable_deploy_docs.yml | 2 +- BUILD.md | 6 +++--- CONTRIBUTING.md | 2 +- docs/snippets/README.md | 2 +- examples/cpp/README.md | 2 +- rerun_cpp/docs/writing_docs.md | 2 +- tests/cpp/log_benchmark/main.cpp | 6 +++--- tests/cpp/plot_dashboard_stress/main.cpp | 4 ++-- 11 files changed, 28 insertions(+), 28 deletions(-) diff --git a/.github/workflows/contrib_checks.yml b/.github/workflows/contrib_checks.yml index bde061b7dfba..ed5e49894fb9 100644 --- a/.github/workflows/contrib_checks.yml +++ b/.github/workflows/contrib_checks.yml @@ -167,12 +167,12 @@ jobs: # 😭 # - name: Build and run C++ tests with clang++ # run: | - # pixi run cpp-clean - # RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=clang++ pixi run cpp-build-all - # RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=clang++ pixi run cpp-test + # pixi run -e cpp cpp-clean + # RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=clang++ pixi run -e cpp cpp-build-all + # RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=clang++ pixi run -e cpp cpp-test - name: Build and run C++ tests with g++ run: | - pixi run cpp-clean - RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=g++ pixi run cpp-build-all - RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=g++ pixi run cpp-test + pixi run -e cpp cpp-clean + RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=g++ pixi run -e cpp cpp-build-all + RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=g++ pixi run -e cpp cpp-test diff --git a/.github/workflows/cpp_matrix_full.json b/.github/workflows/cpp_matrix_full.json index 4d0fd316dbf7..480a153e1074 100644 --- a/.github/workflows/cpp_matrix_full.json +++ b/.github/workflows/cpp_matrix_full.json @@ -5,7 +5,7 @@ "runs_on": "ubuntu-latest-16-cores", "cache_key": "build-linux", "extra_env_vars": "RERUN_USE_ASAN=1 RERUN_SET_CXX_VERSION=17", - "additional_commands": "pixi run cpp-docs" + "additional_commands": "pixi run -e cpp cpp-docs" }, { "name": "Linux x64, C++20", diff --git a/.github/workflows/reusable_checks_cpp.yml b/.github/workflows/reusable_checks_cpp.yml index bc9cf9d4f7a9..c81c3cfa4597 100644 --- a/.github/workflows/reusable_checks_cpp.yml +++ b/.github/workflows/reusable_checks_cpp.yml @@ -88,18 +88,18 @@ jobs: # using leading to random crashes: https://reviews.llvm.org/D148280 run: sudo sysctl vm.mmap_rnd_bits=28 - - name: pixi run cpp-clean - run: pixi run cpp-clean + - name: pixi run -e cpp cpp-clean + run: pixi run -e cpp cpp-clean - - name: pixi run cpp-build-all - run: ${{ matrix.extra_env_vars }} RERUN_WERROR=ON pixi run cpp-build-all + - name: pixi run -e cpp cpp-build-all + run: ${{ matrix.extra_env_vars }} RERUN_WERROR=ON pixi run -e cpp cpp-build-all - - name: pixi run cpp-test - run: ${{ matrix.extra_env_vars }} RERUN_WERROR=ON pixi run cpp-test + - name: pixi run -e cpp cpp-test + run: ${{ matrix.extra_env_vars }} RERUN_WERROR=ON pixi run -e cpp cpp-test - - name: pixi run cpp-build-all-shared-libs + - name: pixi run -e cpp cpp-build-all-shared-libs if: ${{ inputs.CHANNEL == 'nightly' }} - run: ${{ matrix.extra_env_vars }} RERUN_WERROR=ON pixi run cpp-build-all-shared-libs + run: ${{ matrix.extra_env_vars }} RERUN_WERROR=ON pixi run -e cpp cpp-build-all-shared-libs - name: additional_commands run: ${{ matrix.additional_commands }} diff --git a/.github/workflows/reusable_deploy_docs.yml b/.github/workflows/reusable_deploy_docs.yml index 4db6ff8929f8..e67fae2b4d77 100644 --- a/.github/workflows/reusable_deploy_docs.yml +++ b/.github/workflows/reusable_deploy_docs.yml @@ -206,7 +206,7 @@ jobs: pixi-version: v0.25.0 - name: Doxygen C++ docs - run: pixi run cpp-docs + run: pixi run -e cpp cpp-docs - name: Set up git author run: | diff --git a/BUILD.md b/BUILD.md index ed3e5141807a..c0bc6e0745d5 100644 --- a/BUILD.md +++ b/BUILD.md @@ -91,18 +91,18 @@ On Windows you have to have a system install of Visual Studio 2022 in order to c All other dependencies are downloaded by Pixi! You can run tests with: ```sh -pixi run cpp-test +pixi run -e cpp cpp-test ``` and build all C++ artifacts with: ```sh -pixi run cpp-build-all +pixi run -e cpp cpp-build-all ``` ## Building the docs High-level documentation for Rerun can be found at [http://rerun.io/docs](http://rerun.io/docs). It is built from the separate repository [rerun-docs](https://github.com/rerun-io/rerun-docs). -- 🌊 [C++ API docs](https://ref.rerun.io/docs/cpp) are built with `doxygen` and hosted on GitHub. Use `pixi run cpp-docs` to build them locally. For details on the C++ doc-system, see [Writing Docs](rerun_cpp/docs/writing_docs.md). +- 🌊 [C++ API docs](https://ref.rerun.io/docs/cpp) are built with `doxygen` and hosted on GitHub. Use `pixi run -e cpp cpp-docs` to build them locally. For details on the C++ doc-system, see [Writing Docs](rerun_cpp/docs/writing_docs.md). - 🐍 [Python API docs](https://ref.rerun.io/docs/python) are built via `mkdocs` and hosted on GitHub. For details on the Python doc-system, see [Writing Docs](rerun_py/docs/writing_docs.md). - 🦀 [Rust API docs](https://docs.rs/rerun/) are hosted on . You can build them locally with: `cargo doc --all-features --no-deps --open`. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5577d31e1cc7..c7a2bf7413cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -119,7 +119,7 @@ TODO(andreas): This doesn't list tasks from all Pixi environments. There's no wa We use [cargo deny](https://github.com/EmbarkStudios/cargo-deny) to check our dependency tree for copy-left licenses, duplicate dependencies and [rustsec advisories](https://rustsec.org/advisories). You can configure it in `deny.toml`. Usage: `cargo deny check` Configure your editor to run `cargo fmt` on save. Also configure it to strip trailing whitespace, and to end each file with a newline. Settings for VSCode can be found in the `.vscode` folder and should be applied automatically. If you are using another editor, consider adding good setting to this repository! -Depending on the changes you made run `cargo test --all-targets --all-features`, `pixi run py-test` and `pixi run cpp-test` locally. +Depending on the changes you made run `cargo test --all-targets --all-features`, `pixi run py-test` and `pixi run -e cpp cpp-test` locally. ### Linting Prior to pushing changes to a PR, at a minimum, you should always run `pixi run fast-lint`. This is designed to run diff --git a/docs/snippets/README.md b/docs/snippets/README.md index c4d97935d5c3..af69c95a21e0 100644 --- a/docs/snippets/README.md +++ b/docs/snippets/README.md @@ -9,7 +9,7 @@ Most of these examples are automatically used as docstrings for the `Archetype` You can run each example individually using the following: - **C++**: - - `pixi run cpp-build-snippets` to compile all examples + - `pixi run -e cpp cpp-build-snippets` to compile all examples - `./build/docs/snippets/all/` to run, e.g. `./build/docs/snippets/all/point3d_random` - **Python**: `python .py`, e.g. `python point3d_random.py`. - **Rust**: `cargo run -p snippets -- [args]`, e.g. `cargo run -p snippets -- point3d_random`. diff --git a/examples/cpp/README.md b/examples/cpp/README.md index 8579db52f807..8d4e34b241ff 100644 --- a/examples/cpp/README.md +++ b/examples/cpp/README.md @@ -5,7 +5,7 @@ using the accompanying [`C++ Quick Start`](https://www.rerun.io/docs/getting-sta ## Build all examples The CMake target `examples` is a convenient alias for building all CMake examples in one go. -You can use `pixi run cpp-build-examples` to invoke it within the repository's Pixi environment. +You can use `pixi run -e cpp cpp-build-examples` to invoke it within the repository's Pixi environment. After that, you can run individual examples from `./build/examples/cpp/` (e.g. `./build/examples/cpp/dna/example_dna`). ## Contributions welcome diff --git a/rerun_cpp/docs/writing_docs.md b/rerun_cpp/docs/writing_docs.md index 0e29331f03dc..c8c2bc467277 100644 --- a/rerun_cpp/docs/writing_docs.md +++ b/rerun_cpp/docs/writing_docs.md @@ -7,7 +7,7 @@ A high-level overview of writing and previewing the Rerun C++ documentation. ### Serving the docs locally Build the docs using: ``` -pixi run cpp-docs +pixi run -e cpp cpp-docs ``` They then can be locally viewed at `rerun_cpp/docs/html/index.html` diff --git a/tests/cpp/log_benchmark/main.cpp b/tests/cpp/log_benchmark/main.cpp index 08a1e17fa5f1..63051b0d50b5 100644 --- a/tests/cpp/log_benchmark/main.cpp +++ b/tests/cpp/log_benchmark/main.cpp @@ -15,16 +15,16 @@ // // Run all benchmarks using: // ``` -// pixi run cpp-log-benchmark +// pixi run -e cpp cpp-log-benchmark // ``` // Or, run a single benchmark using: // ``` -// pixi run cpp-log-benchmark points3d_large_batch +// pixi run -e cpp cpp-log-benchmark points3d_large_batch // ``` // // For better whole-executable timing capture you can also first build the executable and then run: // ``` -// pixi run cpp-build-log-benchmark +// pixi run -e cpp cpp-build-log-benchmark // ./build/release/tests/cpp/log_benchmark/log_benchmark // ``` // diff --git a/tests/cpp/plot_dashboard_stress/main.cpp b/tests/cpp/plot_dashboard_stress/main.cpp index 08f19cccde81..e45a497b1e74 100644 --- a/tests/cpp/plot_dashboard_stress/main.cpp +++ b/tests/cpp/plot_dashboard_stress/main.cpp @@ -2,12 +2,12 @@ // // Usage: // ```text -// pixi run cpp-plot-dashboard --help +// pixi run -e cpp cpp-plot-dashboard --help // ``` // // Example: // ```text -// pixi run cpp-plot-dashboard --num-plots 10 --num-series-per-plot 5 --num-points-per-series 5000 --freq 1000 +// pixi run -e cpp cpp-plot-dashboard --num-plots 10 --num-series-per-plot 5 --num-points-per-series 5000 --freq 1000 // ``` #include