crosvm: fix documentation for SystemEvent

The documentation for the SystemEvent exit reason needs to specify
the positions for the two fields.

BUG=chromium:797868
TEST=./build_test passes on all architectures

Change-Id: Ida98ba4a6b383a1c10fa48356decc1c5264999ec
Reviewed-on: https://chromium-review.googlesource.com/986721
Commit-Ready: Sonny Rao <sonnyrao@chromium.org>
Tested-by: Sonny Rao <sonnyrao@chromium.org>
Reviewed-by: Zach Reizner <zachr@chromium.org>
This commit is contained in:
Sonny Rao 2018-03-29 14:52:36 -07:00 committed by chrome-bot
parent 45753529ba
commit 00549b04a9

View file

@ -697,8 +697,10 @@ pub enum VcpuExit<'a> {
S390Tsch, S390Tsch,
Epr, Epr,
/// The cpu triggered a system level event which is specified by the type field. /// The cpu triggered a system level event which is specified by the type field.
/// The possible events are shutdown, reset, or crash. /// The first field is the event type and the second field is flags.
SystemEvent(u32 /* event_type*/, u64 /* flags */), /// The possible event types are shutdown, reset, or crash. So far there
/// are not any flags defined.
SystemEvent(u32 /* event_type */, u64 /* flags */),
} }
/// A wrapper around creating and using a VCPU. /// A wrapper around creating and using a VCPU.