Skip to content

Commit 60b83df

Browse files
committed
style: Document recent Go-pointer exceptions
The general rule seems to be: If Go's default value has the same semantics we'd use for an unset value, don't bother with a pointer. I'm not sure how well that squares with [1]: We want a consistent way to identify unset settings. But if the falsy values count as "unset", maybe the "null is a consistent identifier for unset" approach was never really viable. I'm also not sure if the new style extends to integers where zero has the same semantics as unset values. It sounds like Michael was ok with no pointers for those values [2], but OOMScoreAdj (where zero clearly means "do nothing") got a pointer in #233 [3]. More clarity on the threshold would be nice. [1]: #233 (comment) [2]: #233 (comment) [3]: https://github.com/opencontainers/specs/pull/233/files#diff-34c30be66233f08b447fb608ea0e66bbR206 Signed-off-by: W. Trevor King <[email protected]>
1 parent a7b5092 commit 60b83df

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

style.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,12 @@ The redundancy reduction from removing the namespacing prefix is not useful enou
1313
## Optional settings should have pointer Go types
1414

1515
So we have a consistent way to identify unset values ([source][optional-pointer]).
16+
The exceptions are slices, maps, and booleans where the default should be false, in which case `omitempty` is sufficient and no pointer is needed ([source][no-pointer-for-slices] and [source][no-pointer-for-boolean]).
1617

1718
[capabilities]: config-linux.md#capabilities
1819
[class-id]: runtime-config-linux.md#network
1920
[integer-over-hex]: https://github.com/opencontainers/specs/pull/267#discussion_r48360013
2021
[keep-prefix]: https://github.com/opencontainers/specs/pull/159#issuecomment-138728337
22+
[no-pointer-for-boolean]: https://github.com/opencontainers/specs/pull/290#discussion_r50296396
23+
[no-pointer-for-slices]: https://github.com/opencontainers/specs/pull/316/files#r50782982
2124
[optional-pointer]: https://github.com/opencontainers/specs/pull/233#discussion_r47829711

0 commit comments

Comments
 (0)