system_api: add comments for port numbers

Clarify that kGarconPort is what garcon connects to, not listens on.
No functional change.

BUG=b:231500896
TEST=CQ

Change-Id: I31f2a3e13ddcd0809efa0e6613701abff815bf87
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform2/+/3708621
Reviewed-by: Fergus Dall <sidereal@google.com>
Tested-by: Emil Mikulic <easy@google.com>
Commit-Queue: Emil Mikulic <easy@google.com>
Auto-Submit: Emil Mikulic <easy@google.com>
NOKEYCHECK=True
GitOrigin-RevId: a69c4fc8d337500a10a21e7fe4b3d1826e58bd39
1 file changed
tree: e2f65fb0b0a93822d74a83d66fe3eb864d4928de
  1. constants/
  2. dbus/
  3. mojo/
  4. src/
  5. switches/
  6. .gitignore
  7. BUILD.gn
  8. build.rs
  9. Cargo.toml
  10. LICENSE
  11. OWNERS
  12. README.md
  13. system_api.pc
README.md

This directory (platform2/system_api) contains constants and definitions like D-Bus service names that are shared between Chromium and Chromium OS.

This directory is only for things like headers and .proto files. No implementation should be added.

When writting a .proto file make sure to use:

option optimize_for = LITE_RUNTIME;

This will force usage of a lite protobuf instead of a full/heavy weight protobuf. The browser only links against the light version, so you will get cryptic link errors about missing parts of Message if you define a protobuf here and then try to use it in Chrome. Currently CrOS links against the full protobuffer library, but that might change in the future.

When declaring a protobuf, avoid use of required unless it is exactly what you mean. “Required is Forever” and very rarely should actually be used. Consult Protocol Buffer Basics: C++ for a detailed of this issue.