Google Git
Sign in
fuchsia / protobuf-gn / refs/heads/main
commitff123a0114aec4c2ab42d9cfb8716d88a69b037c[log] [tgz]
authorAnivia Li <aniviali@google.com>Fri Aug 15 10:04:36 2025 -0700
committerAnivia Li <aniviali@google.com>Fri Aug 15 10:04:54 2025 -0700
tree53c824c5567f9c7be57b771ee3890a5d67257c01
parent7d2a723520bf7ca3672c8b1e8865dff35e0faa26 [diff]
Add instructions for updating BUILD.gn.

Declare that `BUILD.gn` file is generated from `BUILD.input.gn`. The README is updated to include a warning against editing `BUILD.gn` directly and provides steps to modify `BUILD.input.gn` and run `gen.py` to regenerate `BUILD.gn`.

Fixed: 425997503

Change-Id: I6b04b74b370b6667367dfc098ecd02a8302e83a1
1 file changed
tree: 53c824c5567f9c7be57b771ee3890a5d67257c01
  1. upb_generator/
  2. AUTHORS
  3. BUILD.gn
  4. BUILD.input.gn
  5. CONTRIBUTING.md
  6. gen.py
  7. LICENSE
  8. OWNERS
  9. PATENTS
  10. proto_library.gni
  11. protoc_wrapper.py
  12. README.md
README.md

Protocol Buffers GN Build Support

This repository contains GN build system support for Protocol Buffers. It's in its own repository because it needs to be shared by Fuchsia and Cobalt.

This repo should be checked out such that:

  • It is in //build/secondary/third_party/protobuf.
  • Protobuf is in //third_party/protobuf.
  • //.gn contains secondary_source = "//build/secondary/"

See the GN documentation on secondary_source.

Updating Build Files

WARNING: DO NOT MODIFY THE BUILD.gn FILE DIRECTLY!

The BUILD.gn file in this directory is generated automatically. Any manual changes will be overwritten.

To make changes to the build configuration:

  1. Edit the BUILD.input.gn file to suit your needs, for example managing visibility, suppressing warnings, etc.
  2. Checkout //third_party/protobuf to the target version.
  3. Run the gen.py script located in this directory to regenerate the BUILD.gn file.
  4. Commit both the updated BUILD.input.gn and the newly generated BUILD.gn file.

Failing to modify BUILD.input.gn will result in your changes being lost the next time the build file is regenerated.