Document reflect.TypeOf hint (#211)

* Document reflect.TypeOf hint

Fixes #163

* Fix nit
pull/213/head
lu4p 3 years ago committed by GitHub
parent 2d720ae155
commit 91deb1e224
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -52,6 +52,18 @@ to document the current shortcomings of this tool.
* Go plugins are not currently supported; see [#87](https://github.com/burrowers/garble/issues/87).
* There are cases where garble is a little too agressive with obfuscation, this may lead to identifiers getting obfuscated which are needed for reflection, e.g. to parse JSON into a struct; see [#162](https://github.com/burrowers/garble/issues/162). To work around this you can pass a hint to garble, that an type is used for reflection via passing it to `reflect.TypeOf` or `reflect.ValueOf` in the same file:
```go
// this is used for parsing json
type Message struct {
Command string
Args string
}
// never obfuscate the Message type
var _ = reflect.TypeOf(Message{})
```
### Tiny Mode
When the `-tiny` flag is passed, extra information is stripped from the resulting

Loading…
Cancel
Save