diff options
| author | Michael Pratt <mpratt@google.com> | 2020-08-20 13:28:43 -0700 |
|---|---|---|
| committer | gVisor bot <gvisor-bot@google.com> | 2020-08-20 13:32:24 -0700 |
| commit | 129018ab3d945758b800aa5e6fe1a01d0e99446c (patch) | |
| tree | ee86101d771a7b838ad7d3ce02edae90a6f24018 /pkg/sentry/platform/interrupt/interrupt.go | |
| parent | f12b545d8fc484f0bb48f280d161acb348263372 (diff) | |
Consistent precondition formatting
Our "Preconditions:" blocks are very useful to determine the input invariants,
but they are bit inconsistent throughout the codebase, which makes them harder
to read (particularly cases with 5+ conditions in a single paragraph).
I've reformatted all of the cases to fit in simple rules:
1. Cases with a single condition are placed on a single line.
2. Cases with multiple conditions are placed in a bulleted list.
This format has been added to the style guide.
I've also mentioned "Postconditions:", though those are much less frequently
used, and all uses already match this style.
PiperOrigin-RevId: 327687465
Diffstat (limited to 'pkg/sentry/platform/interrupt/interrupt.go')
| -rw-r--r-- | pkg/sentry/platform/interrupt/interrupt.go | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/pkg/sentry/platform/interrupt/interrupt.go b/pkg/sentry/platform/interrupt/interrupt.go index 57be41647..9dfac3eae 100644 --- a/pkg/sentry/platform/interrupt/interrupt.go +++ b/pkg/sentry/platform/interrupt/interrupt.go @@ -54,8 +54,9 @@ type Forwarder struct { // } // defer f.Disable() // -// Preconditions: r must not be nil. f must not already be forwarding -// interrupts to a Receiver. +// Preconditions: +// * r must not be nil. +// * f must not already be forwarding interrupts to a Receiver. func (f *Forwarder) Enable(r Receiver) bool { if r == nil { panic("nil Receiver") |