on master help sign in
dist/tools: correct force-off/force-on description
commitaa828cf661a8f0d0c1387f9d67759fb3935fd0bc authortinnus-napbus <admin@tinnus-napbus.xyz> dateTue 5 Oct 2021, 22:33 (5 years ago) parent6c90071
1 file changed+3−3
content/docs/userspace/dist/tools.md+3−3
content/docs/userspace/dist/tools.md+3−3
@@ -29,8 +29,8 @@ Fields:
2929- `base hash` - The merge base (common ancestor) between the desk and its upstream source.
3030- `%cz hash` - The hash of the desk.
3131- `app status` - May be `suspended` or `running`.
32−- `force on` - Whether the desk has been force-started.
33−- `force off` - Whether the desk has been force-stopped.
32+- `force on` - The set of agents on the desk which have been manually started despite not being on the `desk.bill` manifest.
33+- `force off` - The set of agents on the desk which have been manually stopped despite being on the `desk.bill` manifest.
3434- `publishing ship` - The original publisher if the source ship is republishing the desk.
3535- `updates` - May be `local`, `tracking` or `paused`. Local means it will receive updates via commits on the local ship. Tracking means it will receive updates from the `source ship`. Paused means it will not receive updates.
3636- `source desk` - The desk on the `source ship`.
@@ -175,7 +175,7 @@ ship desk, =local desk
175175
176176Uninstall a desk, suspending its agents and ignoring updates.
177177
178−The specified desk will be retained in Clay, but its agents will all be stopped and have their states archived like [`|suspend`](#suspend).
178+The specified desk will be retained in Clay, but its agents will all be stopped and have their states archived like [`|suspend`](#suspend). This is the reverse of [`|install`](#install).
179179
180180Note that this will not remove the tile or glob from the homescreen, so if the desk has a tile it should be uninstalled with the "Remove App" button in the tile's hamburger menu.
181181