From fe9e49690385433f9930ec132012c7d9469fb706 Mon Sep 17 00:00:00 2001 From: Matt Keeter Date: Wed, 4 Mar 2026 10:55:45 -0500 Subject: [PATCH 1/2] Update README --- README.md | 26 +------------------------- 1 file changed, 1 insertion(+), 25 deletions(-) diff --git a/README.md b/README.md index 43348225..e6f06e6a 100644 --- a/README.md +++ b/README.md @@ -203,7 +203,7 @@ option to humility. The above definition -- when provided via `--environment` or `HUMILITY_ENVIRONMENT` -- would allow one to (say) run `humility --target -grimey tasks` or `humility --target lucky --archive-name imagea tasks`. +grimey tasks` or `humility --target lucky --image-name imagea tasks`. In addition to `probe` and `archive`, one may also specify associated commands in a `cmds` object that contains a mapping of names to commands to execute. For example: @@ -234,7 +234,6 @@ a specified target. (In the above example, one could execute `humility - [humility apptable](#humility-apptable): print Hubris apptable - [humility auxflash](#humility-auxflash): manipulate auxiliary flash -- [humility bankerase](#humility-bankerase): Erase a bank - [humility console-proxy](#humility-console-proxy): SP/host console uart proxy - [humility counters](#humility-counters): display event counters - [humility dashboard](#humility-dashboard): dashboard for Hubris sensor data @@ -307,19 +306,6 @@ This subcommand should be rarely used; `humility flash` will automatically program auxiliary flash when needed. -### `humility bankerase` - -Erase flash in "erase block" size chunks (32 KiB) on the RoT. - -Erase `len` is given in bytes and then rounded up to the nearest block -size so that all pages containing the range are erased. Then the erased -pages are overwritten with 0s, but only starting at the address given. In -other words, if the address is given as 0x40001 and len as 512, flash will -be erased from 0x40000 to 0x48000, but address 0x40000 will have value -`0xff`, and every other byte will have value `0`. - - - ### `humility console-proxy` Act as a proxy for the host serial console when it is jumpered to the SP. @@ -1161,16 +1147,6 @@ humility: attached via ST-Link Controller I2C3, device 0x48, register 0x4 = 0x1f ``` -To determine the last mux and segment to be enabled on a particular -controller/port, use `--lastmux` (`-l`): - -```console -$ humility i2c -b front --lastmux -humility: attached via ST-Link V3 -last selected mux/segment for I2C2, port F: mux 3, segment 2 -``` - - ### `humility ibc` From 60211100aeae2472de0a2891c5a7f70008460ee3 Mon Sep 17 00:00:00 2001 From: Matt Keeter Date: Fri, 6 Mar 2026 11:14:30 -0500 Subject: [PATCH 2/2] Add README CI task to make sure it's up to date --- .github/workflows/readme.yml | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 .github/workflows/readme.yml diff --git a/.github/workflows/readme.yml b/.github/workflows/readme.yml new file mode 100644 index 00000000..8453b927 --- /dev/null +++ b/.github/workflows/readme.yml @@ -0,0 +1,29 @@ +name: readme +on: + pull_request: + push: + branches: [master] + +jobs: + readme: + runs-on: ubuntu-latest + steps: + - name: Install Dependencies + run: sudo apt-get update && sudo apt-get install libusb-1.0-0-dev libftdi1-dev libudev-dev + - uses: actions/checkout@v2 + with: + submodules: true + - uses: actions-rs/toolchain@v1 + with: + profile: minimal + toolchain: stable + override: true + - uses: Swatinem/rust-cache@v1 + - name: Run cargo xtask readme + run: cargo xtask readme + - name: Check README.md is up to date + run: | + if ! git diff --exit-code README.md; then + echo "README is out of date; run \`cargo xtask readme\` to update it" + exit 1 + fi