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