on master help sign in
care modes
c9cdd32drbeefsupreme
arvo/clay/data-types.md+18−17
@@ -198,42 +198,43 @@ any of its children.
198This specifies what type of information is requested in a subscription
198This specifies what type of information is requested in a subscription
199or a scry.
199or a scry.
200
200
201−`%a` build a Hoon file at a path.
201+`%a` build a Hoon file at a `path`.
202
202
203−`%b` build a dynamically typed mark by name (a `$dais` mark-interface core).
203+`%b` build a dynamically typed `mark` by name (a `$dais` mark-interface core).
204
204
205−`%c` build a dynamically typed mark conversion gate (a `$tube`) by "from" and
205+`%c` build a dynamically typed `mark` conversion gate (a `$tube`) by "from" and
206−"to" mark names
206+"to" `mark` names.
207
207
208−`%d` retrieves a `set desk`. `.^((set desk) %cd %)`.
208+`%d` returns a `(set desk)` of the `desk`s that exist on your ship.
209
209
210−`%e` builds a statically typed mark by name (a `$nave` mark-interface core).
210+`%e` builds a statically typed `mark` by name (a `$nave` mark-interface core).
211
211
212`%f` builds a statically typed mark converstion gate.
212`%f` builds a statically typed mark converstion gate.
213
213
214−`%p` produces the permissions for a directory.
214+`%p` produces the permissions for a directory, returned as a `[dict:clay dict:clay]`.
215
215
216−`%r` requests the file in the same fashion as `%x`, but wraps the result in a vase.
216+`%r` requests the file in the same fashion as `%x`, but wraps the result in a `vase`.
217
217
218`%s` has miscellaneous debug endpoints.
218`%s` has miscellaneous debug endpoints.
219
219
220−`%t` produces a list of descendent paths for a directory within a `yaki`.
220+`%t` produces a `(list path)` of descendent `path`s for a directory within a `yaki`.
221
221
222−`%u` checks whether or not the specified file exists. It does not check any of
222+`%u` produces a `?` depending on whether or not the specified file exists. It
223−its children.
223+does not check any of its children.
224
224
225`%v` requests the entire `dome` for a specified `desk` at a particular `aeon`.
225`%v` requests the entire `dome` for a specified `desk` at a particular `aeon`.
226When used on a foreign `desk`, this get us up-to-date to the requested version.
226When used on a foreign `desk`, this get us up-to-date to the requested version.
227
227
228−`%w` requests the version number and date of the specified path.
228+`%w` requests the revision number and date of the specified path, returned as a `cass:clay`.
229
229
230−`%x` requests the file at a specified path at the specified commit. If
230+`%x` requests the file at a specified path at the specified commit, returned as
231−there is no node at that path or if the node has no contents (that is,
231+an `@`. If there is no node at that path or if the node has no contents (that
232−if `q:ankh` is null), then this produces null.
232+is, if `fil:ankh` is null), then this crashes.
233
233
234−`%y` requests an `arch` of the specfied commit at the specified path.
234+`%y` requests an `arch` of the specfied commit at the specified path. It will
235+return the bunt of an `arch` if the file or directory is not found.
235
236
236−`%z` requests a recursive hash of a node and all its children.
237+`%z` requests a recursive hash of a node and all its children, returned as a `@uxI`.
237
238
238#### `$ankh`, filesystem node
239#### `$ankh`, filesystem node
239
240