From 00549b04a9a4240d9313769c446d4be30d634c1f Mon Sep 17 00:00:00 2001
From: Sonny Rao <sonnyrao@chromium.org>
Date: Thu, 29 Mar 2018 14:52:36 -0700
Subject: [PATCH] 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>
---
 kvm/src/lib.rs | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/kvm/src/lib.rs b/kvm/src/lib.rs
index 04810b2067..539a4a4935 100644
--- a/kvm/src/lib.rs
+++ b/kvm/src/lib.rs
@@ -697,8 +697,10 @@ pub enum VcpuExit<'a> {
     S390Tsch,
     Epr,
     /// The cpu triggered a system level event which is specified by the type field.
-    /// The possible events are shutdown, reset, or crash.
-    SystemEvent(u32 /* event_type*/, u64 /* flags */),
+    /// The first field is the event type and the second field is 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.