diff options
| author | Matthias Beyer <mail@beyermatthias.de> | 2018-08-02 01:53:44 +0200 |
|---|---|---|
| committer | Matthias Beyer <mail@beyermatthias.de> | 2018-11-06 20:32:34 +0100 |
| commit | 8552843796de9628386e317b1c1452c5ef87c500 (patch) | |
| tree | ee59af47391fd09e549421f325559ed756418ac9 /doc/src | |
| parent | 8c597d2c4dbf6f66c522a708014a1865d3376741 (diff) | |
doc: Add note on IO conventions
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/03010-conventions.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/src/03010-conventions.md b/doc/src/03010-conventions.md index a6cf4d3e..661745d1 100644 --- a/doc/src/03010-conventions.md +++ b/doc/src/03010-conventions.md @@ -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). + |