jianglk.darker
7ee447c011
|
4 months ago | |
---|---|---|
.. | ||
android | 4 months ago | |
OWNERS | 4 months ago | |
README.md | 4 months ago |
README.md
Conventions for the protos in this directory:
-
As in the rest of Android, use 4 spaces to indent instead of 2.
-
For protos based on Java files, use the same package as the Java file. For example,
com.android.server.thing
instead ofcom.android.server.thing.proto
. -
If the proto describes the top level output of dumpsys, it should contain
Dump
. This makes it easy to understand that the proto is the dumpsys output of a certain service, not the data structure of that service, e.g.WindowManagerServiceDumpProto
vsWindowManagerServiceProto
.- Inner messages whose containing messages have the
Proto
suffix do not need to have aProto
suffix. E.g:
- Inner messages whose containing messages have the
message FooProto {
message Bar {
...
}
}
vs
message FooProto {
message BarProto {
...
}
}
-
If the proto represents the structure of an object, it should have
Proto
as its suffix. Please also include the full package path of the original object as a comment to the proto message. -
Include units in the field names. For example,
screen_time_ms
vsscreen_time
, orfile_size_bytes
orfile_size_mebibytes
vsfile_size
. -
Leave field numbers 50,000 - 100,000 reserved for OEMs.