readme.md
1 # bugreportz protocol
2
3 `bugreportz` is used to generate a zippped bugreport whose path is passed back to `adb`, using
4 the simple protocol defined below.
5
6 # Version 1.1
7 On version 1.1, in addition to the `OK` and `FAILURE` lines, when `bugreportz` is invoked with
8 `-p`, it outputs the following lines:
9
10 - `BEGIN:<path_to_bugreport_file>` right away.
11 - `PROGRESS:<progress>/<total>` as `dumpstate` progresses (where `<progress>` is the current
12 progress units out of a max of `<total>`).
13
14 ## Version 1.0
15 On version 1.0, `bugreportz` does not generate any output on `stdout` until the bugreport is
16 finished, when it then prints one line with the result:
17
18 - `OK:<path_to_bugreport_file>` in case of success.
19 - `FAIL:<error message>` in case of failure.
20
21