on master help sign in
Merge pull request #914 from urbit/fix-ames-headings

fixes headers for Ames public API

commit6c62bde41223ac1dc8b4e7c9af51688f16fcf01d authorpoprox <51337059+syzygyzer@users.noreply.github.com> dateFri 17 Jul 2020, 16:18 (6 years ago) parent55e15794046ac3
1 file changed+15−13
reference/vane-apis/ames.md+15−13
reference/vane-apis/ames.md+15−13
@@ -1,5 +1,5 @@
11+++
2−title = "Ames Public API"
2+title = "Ames"
33weight = 2
44template = "doc.html"
55+++
@@ -18,7 +18,7 @@ system/lifecycle tasks.
1818
1919## Messaging Tasks
2020
21−### %hear
21+### `%hear`
2222
2323`%hear` handles raw packet receipt. This `task` only ever originates from Unix.
2424It does the initial processing of a packet, namely by passing the raw packet
@@ -47,7 +47,7 @@ zero or more additional packets via `%send` `gift`s. It may also trigger a `%boo
4747or `%plea` `gift` (collectively referred to as a `%memo` within Ames) to a local vane in the case of a completed message.
4848
4949
50−### %heed
50+### `%heed`
5151
5252A vane can pass Ames a `%heed` `task` to request Ames track a peer's
5353responsiveness. If our `%boon`s to it start backing up locally,
@@ -73,7 +73,7 @@ Ames will `give` a `%clog` `gift` to the requesting vane containing the
7373unresponsive peer's urbit address.
7474
7575
76−### %hole
76+### `%hole`
7777
7878`%hole` handles packet crash notification. `%hole` works much like `%hear`, in
7979that it passes an incoming raw packet to `+decode-packet` to be deserialized,
@@ -95,7 +95,8 @@ message (typically an IP address).
9595Like `%hear`, `%hole` can trigger additional packets in the form of `%send`
9696`gift`s, and may also yield a `%boon` or `%plea` `gift` to a local vane.
9797
98−### %jilt
98+
99+### `%jilt`
99100
100101`%jilt` stops tracking a potentially unresponsive peer that was previously being
101102tracked as a result of the `%heed` `task`.
@@ -114,7 +115,8 @@ The `ship` we no longer wish to track.
114115
115116This `task` returns no `gift`s.
116117
117−### %plea
118+
119+### `%plea`
118120
119121`%plea` is the `task` used to send messages over Ames. It extends the
120122`%pass`/`%give` semantics across the network. As such, it is the most
@@ -146,7 +148,7 @@ This `task` returns no `gift`s.
146148
147149## System and Lifecycle Tasks
148150
149−### %born
151+### `%born`
150152
151153Each time you start your Urbit, the Arvo kernel calls the `%born` task for Ames.
152154
@@ -159,7 +161,7 @@ Each time you start your Urbit, the Arvo kernel calls the `%born` task for Ames.
159161In response to a `%born` `task`, Ames `%give`s Jael a `%turf` `gift`.
160162
161163
162−### %crud
164+### `%crud`
163165
164166`%crud` is called whenever an error involving Ames occurs. It produces a crash
165167report in response.
@@ -178,7 +180,7 @@ Ames does not `give` a `gift` in response to a `%crud` `task`, but it does
178180`%pass` Dill a `%flog` `task` instructing it to print `error`.
179181
180182
181−## %init
183+## `%init`
182184
183185`%init` is called a single time during the very first boot process, immediately
184186after the [larval stage](@/docs/tutorials/arvo/arvo.md#larval-stage-core)
@@ -206,7 +208,7 @@ our=ship
206208`%init` sends two moves that subscribe to `%turf` and `%private-keys` in Jael.
207209
208210
209−### %sift
211+### `%sift`
210212
211213This `task` filters debug output by ship.
212214
@@ -223,7 +225,7 @@ The list of ships for which debug output is desired.
223225This `task` returns no `gift`s.
224226
225227
226−### %spew
228+### `%spew`
227229
228230Sets verbosity toggles on debug output. These toggles are as follows.
229231
@@ -256,7 +258,7 @@ verbs=(list verb)
256258This `task` returns no `gift`s.
257259
258260
259−### %vega
261+### `%vega`
260262
261263`%vega` is called whenever the kernel is updated. Ames currently does not do
262264anything in response to this.
@@ -270,7 +272,7 @@ anything in response to this.
270272This `task` returns no `gift`s.
271273
272274
273−### %wegh
275+### `%wegh`
274276
275277This `task` is a request to Ames to produce a memory usage report.
276278