summaryrefslogtreecommitdiffhomepage
path: root/tools/go_marshal/README.md
diff options
context:
space:
mode:
authorRahat Mahmood <rahat@google.com>2020-09-29 12:32:32 -0700
committergVisor bot <gvisor-bot@google.com>2020-09-29 12:34:30 -0700
commit44c7d550747a61baa6a85643de439fa45c2b9633 (patch)
treee64c757ab24cc12c3180f10651c460f0a026a513 /tools/go_marshal/README.md
parent7d64bc1fdf538869de5964475110a69580b481ad (diff)
Support embedded fields in go-marshal.
PiperOrigin-RevId: 334437990
Diffstat (limited to 'tools/go_marshal/README.md')
-rw-r--r--tools/go_marshal/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/tools/go_marshal/README.md b/tools/go_marshal/README.md
index 75e5c7888..d8045c295 100644
--- a/tools/go_marshal/README.md
+++ b/tools/go_marshal/README.md
@@ -113,3 +113,18 @@ The following are some guidelines for modifying the `go_marshal` tool:
- No runtime reflection in the code generated for the marshallable interface.
The entire point of the tool is to avoid runtime reflection. The generated
tests may use reflection.
+
+## Debugging
+
+To enable debugging output from the go-marshal tool, use one of the following
+options, depending on how go-marshal is being invoked:
+
+- Pass `--define gomarshal=verbose` to the bazel command. Note that this can
+ generate a lot of output depending on what's being compiled, as this will
+ enable debugging for all packages built by the command.
+
+- Set `marshal_debug = True` on the top-level `go_library` BUILD rule.
+
+- Set `debug = True` on the `go_marshal` BUILD rule.
+
+- Pass `-debug` to the go-marshal tool invocation.