on master help sign in
dist/tools: correct force-off/force-on description
aa828cftinnus-napbus
content/docs/userspace/dist/tools.md+3−3
@@ -29,8 +29,8 @@ Fields:
29- `base hash` - The merge base (common ancestor) between the desk and its upstream source.
29- `base hash` - The merge base (common ancestor) between the desk and its upstream source.
30- `%cz hash` - The hash of the desk.
30- `%cz hash` - The hash of the desk.
31- `app status` - May be `suspended` or `running`.
31- `app status` - May be `suspended` or `running`.
32−- `force on` - Whether the desk has been force-started.
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` - Whether the desk has been force-stopped.
33+- `force off` - The set of agents on the desk which have been manually stopped despite being on the `desk.bill` manifest.
34- `publishing ship` - The original publisher if the source ship is republishing the desk.
34- `publishing ship` - The original publisher if the source ship is republishing the desk.
35- `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.
35- `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.
36- `source desk` - The desk on the `source ship`.
36- `source desk` - The desk on the `source ship`.
@@ -175,7 +175,7 @@ ship desk, =local desk
175
175
176Uninstall a desk, suspending its agents and ignoring updates.
176Uninstall a desk, suspending its agents and ignoring updates.
177
177
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).
179
179
180Note 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.
180Note 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.
181
181