revi-archive/phorge-arcanist
1
0
Fork 0
mirror of https://we.phorge.it/source/arcanist.git synced 2024-11-22 06:42:41 +01:00
Code Issues Releases Wiki Activity

Improve documentation for 'arc call-conduit'

Browse source 
Summary:
This documentation isn't terribly clear and it isn't obvious how to use the
workflow. Make it more clear and provide examples.

Test Plan:
Ran "arc help call-conduit"

Reviewed By: gc3
Reviewers: gc3, aran, jungejason
CC: aran, gc3, epriestley
Differential Revision: 502
This commit is contained in:
epriestley 2011-06-22 17:52:37 -07:00
parent 5171ec161a
commit b6fb0f7a6b
1 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/workflow/call-conduit/ArcanistCallConduitWorkflow.php
View file

@ -27,10 +27,18 @@ class ArcanistCallConduitWorkflow extends ArcanistBaseWorkflow {
return phutil_console_format(<<<EOTEXT return phutil_console_format(<<<EOTEXT
**call-conduit** __method__ **call-conduit** __method__
Supports: http, https Supports: http, https
Allows you to make a raw Conduit method call. Call parameters are read Allows you to make a raw Conduit method call:
as a JSON blob from stdin. Results are written to stdout as a JSON
blob. This workflow is primarily useful for writing scripts which - Run this command from a working directory.
integrate with Phabricator. - Call parameters are REQUIRED and read as a JSON blob from stdin.
- Results are written to stdout as a JSON blob.
This workflow is primarily useful for writing scripts which integrate
with Phabricator. Examples:
$ echo '{}' | arc call-conduit conduit.ping
$ echo '{"phid":"PHID-FILE-xxxx"}' | arc call-conduit file.download
EOTEXT EOTEXT
); );
} }