Merge #338

338: Tidies up the configuration to better support VS Code r=jonas-schievink a=huntc

This configuration update reflects the strategy taken with Embassy where a `Cargo.example.toml` is provided. This example is expected to be updated by the developer and customised for the target they are interested in. Without these changes, working with `nrf-hal` is quite unpleasant in Visual Studio Code.

A `Cargo.ci.toml` is provided and used by CI. This file is the original `Cargo.toml`.

Thanks to @Dirbaio for the recommendations.

Co-authored-by: huntc <[email protected]>
Co-authored-by: Jonas Schievink <[email protected]>

Author: 3 people

.github/workflows/ci.yml

@@ -33,7 +33,7 @@ jobs:
         thumbv7em-none-eabihf
         thumbv8m.main-none-eabi
     - name: Build Crates
-      run: cargo test -p xtask
+      run: mv Cargo.ci.toml Cargo.toml && cargo test -p xtask
       env:
         RUSTFLAGS: ${{ matrix.rustflags }}
 

.gitignore

@@ -3,6 +3,8 @@
 [._]*.sw[a-p]
 **/*.rs.bk
 Cargo.lock
+Cargo.toml
+Cargo.my.toml
 
 # Created by https://www.gitignore.io/api/intellij+all
 

.vscode/settings.json

@@ -1,5 +1,4 @@
 {
-    "rust-analyzer.cargo.features": [
-        "52840"
-    ]
+    "rust-analyzer.cargo.target": "thumbv7em-none-eabi",
+    "rust-analyzer.checkOnSave.allTargets": false,
 }

CONTRIBUTING.md

@@ -23,6 +23,15 @@ even if not breaking changes by themselves, will only be included in the next ma
 
 ## Release process
 
+The release process requires the workspace to be setup as per when performing Continuous Integration.
+Please follow these steps before you begin (shown for Unix):
+
+1. Keep a copy of your existing `Cargo.toml` - `mv Cargo.toml Cargo.my.toml`. Note that `Cargo.my.toml`
+is ignored for the repository so it cannot be accidentally committed.
+2. Activate the CI workspace - `cp Cargo.ci.toml Cargo.toml`.
+
+When finished releasing, copy or move your `Cargo.my.toml` back.
+
 In order to release a new version of the HALs, the following steps need to be performed:
 
 * **Changelog**: Update [the changelog](./CHANGELOG.md) to list all notable changes under the `Unreleased`

Cargo.toml renamed to Cargo.ci.toml

@@ -0,0 +1,36 @@
+# This file is a template for a Cargo workspace for developer convenience.
+#
+# Since Cargo resolves all features for all crates in the workspace together, 
+# it is not possible to have a workspace with all the crates together, since they
+# enable incompatible features.
+#
+# Instead, we provide this template so you can enable only the crates you're going to
+# work on. This makes eg rust-analyzer check-on-save and autocomplete work, but only 
+# in these crates, without any feature conflict.
+#
+# Copy this file to `Cargo.toml` and uncomment one group of crates below.
+#
+# `/Cargo.toml` is already in .gitignore, so you don't commit it accidentally.
+
+[workspace]
+members = [
+#  Uncomment ONLY ONE of the hals below, depending on your target
+#  "nrf52810-hal",
+#  "nrf52811-hal",
+#  "nrf52832-hal",
+#  "nrf52833-hal",
+  "nrf52840-hal",
+  "nrf52840-hal-tests",
+#  "nrf9160-hal",
+]
+
+[profile.dev]
+incremental = false
+codegen-units = 1
+debug = true
+lto = false
+
+[profile.release]
+debug = true
+lto = true
+opt-level = "s"

Cargo.example.toml

@@ -37,6 +37,12 @@ Every nRF chip has its own crate, listed below:
 
 \* These devices do not have a separate development kit and share the [NRF52 DK](https://www.nordicsemi.com/Software-and-tools/Development-Kits/nRF52-DK)
 
+## Development
+
+Be sure to copy and edit the `Cargo.example.toml` file to `Cargo.toml`. The file will require editing dependent on the target you wish to work with and contains some further
+instructions. Similarly, check out the `.vscode/settings.json` file when used in the context of Visual Studio Code. By default, all of these files are configured to work
+with the nRF52840 target.
+
 ## License
 
 Licensed under either of