matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

doc: Add note on IO conventions

Browse source
This commit is contained in:
Matthias Beyer 2018-08-02 01:53:44 +02:00
parent 8c597d2c4d
commit 8552843796
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/src/03010-conventions.md
View file

@ -104,3 +104,14 @@ Commandline interfaces should also provide a flag "-I" (that's a big i) which
marks that the store IDs shall be read from stdin and are not passed via the
commandline.
### IO
There are minor restrictions how imag tools should do IO. A good rule of thumb
is (but most certainly only applicable when programming an imag tool in Rust):
use `libimagrt` to do IO of any kind.
For more information, or if not using Rust as programming language: the
documentation of `libimagrt` describes how IO should happen (which output
stream to use, how input should be done).