Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/workflows/readme.yml
Original file line number Diff line number Diff line change
@@ -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
26 changes: 1 addition & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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`

Expand Down
Loading