From 679a57c70432cda291d7dd805b4ecfc58fbf3497 Mon Sep 17 00:00:00 2001
From: Alex Dadgar <alex.dadgar@gmail.com>
Date: Mon, 1 Feb 2016 18:15:12 -0800
Subject: [PATCH] Comment on AllocModifyIndex

---
 nomad/structs/structs.go | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/nomad/structs/structs.go b/nomad/structs/structs.go
index c63bae5a4..d89767927 100644
--- a/nomad/structs/structs.go
+++ b/nomad/structs/structs.go
@@ -1675,8 +1675,11 @@ type Allocation struct {
 	TaskStates map[string]*TaskState
 
 	// Raft Indexes
-	CreateIndex      uint64
-	ModifyIndex      uint64
+	CreateIndex uint64
+	ModifyIndex uint64
+
+	// AllocModifyIndex is not updated when the client updates allocations. This
+	// lets the client pull only the allocs updated by the server.
 	AllocModifyIndex uint64
 }