ilyakooo0/urbit
1
0
Fork 0
mirror of https://github.com/ilyakooo0/urbit.git synced 2024-12-20 21:31:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

conn: cleanup docs, document %peel

Browse Source
This commit is contained in:
Jōshin 2022-02-10 23:21:30 -08:00
parent 80d4400d53
commit f1b5e6a0dc
No known key found for this signature in database
GPG Key ID: A8BE5A9A521639D0
1 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
pkg/urbit/vere/io/conn.c
View File

@ -5,13 +5,13 @@
**
** the control plane nominally consumes input described by:
**
** $: request-id=@ :: id sent in response
** $% [%fyrd fyrd-args=*] :: run a thread
** [%peek peek-args=*] :: scry
** [%peel peel-args=*] :: runtime peek
** [%ovum ovum-args=*] :: inject raw ovum
** [%urth urth-args=*] :: runtime command
** == ==
** $: request-id=@ :: id for response
** $% [%fyrd fyrd-args=*] :: run a thread
** [%peek peek-args=*] :: scry
** [%peel peel-args=*] :: runtime peek
** [%ovum ovum-args=*] :: inject raw ovum
** [%urth urth-args=*] :: runtime command
** == == ::
**
** request-id is a client-supplied atomic identifier that will
** be returned along with the response, to allow correlating
@ -21,9 +21,9 @@
** described in the ++khan section of sys/lull.hoon. to
** summarize:
**
** +$ task $%(... [%fyrd p=fyrd]) ::
** +$ fyrd [=bear name=term =mark data=(cask)] :: thread request
** +$ bear $@(desk [desk case]) :: partial +beak
** +$ task $%(... [%fyrd p=fyrd]) ::
** +$ fyrd [=bear name=term =out=mark data=(cask)] :: thread request
** +$ bear $@(desk beak) :: partial $beak
**
** the passed mark is applied to the output. the cask (short for
** (cask *)) at data contains the input mark. e.g. to run -code
@ -48,8 +48,11 @@
** ==
**
** %peel is a runtime "peek". it exposes an unprincipled
** namespace allowing querying of various metrics about the
** state of vere.
** scry-like namespace allowing querying of various metrics
** about the state of vere. /help produces a list of available
** commands. /args produces the command-line arguments used to
** start vere. /vars produces runtime metrics at the moment in
** time that the request was received.
**
** %ovum is a raw kernel move, to be injected directly into
** arvo. needless to say this will void your warranty. usually