Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit cddeb74c authored by Kweku Adams's avatar Kweku Adams Committed by android-build-merger
Browse files

Merge "Documenting some core proto style conventions." into pi-dev

am: df9737d2

Change-Id: I9bbef2a5c5b9d37d4a4e719032203c31a21bf3d3
parents 2d6384ed df9737d2
Loading
Loading
Loading
Loading

core/proto/README.md

0 → 100644
+41 −0
Original line number Original line Diff line number Diff line
Conventions for the protos in this directory:

1. As in the rest of Android, use 4 spaces to indent instead of 2.

1. For protos based on Java files, use the same package as the Java file. For
   example, `com.android.server.thing` instead of `com.android.server.thing.proto`.

1. 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` vs `WindowManagerServiceDumpProto`.

   * Inner messages whose containing messages have the `Proto` suffix do not
     need to have a `Proto` suffix. E.g:

```
message FooProto {
    message Bar {
        ...
    }
}
```

     vs

```
message FooProto {
    message BarProto {
        ...
    }
}
```

1. 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.

1. Include units in the field names. For example, `screen_time_ms` vs
   `screen_time`, or `file_size_bytes` or `file_size_mebibytes` vs `file_size`.

1. Leave field numbers 50,000 - 100,000 reserved for OEMs.
+3 −0
Original line number Original line Diff line number Diff line
@@ -280,4 +280,7 @@ message IncidentProto {
        (section).type = SECTION_DUMPSYS,
        (section).type = SECTION_DUMPSYS,
        (section).args = "usb --proto"
        (section).args = "usb --proto"
    ];
    ];

    // Reserved for OEMs.
    extensions 50000 to 100000;
}
}