Mesa (master): vbo: update comments for vbo_save_NotifyBegin()

[Brian Paul]

Module: Mesa
Branch: master
Commit: af30987a69848795d700357c3190b5adf44749fa
URL:    http://cgit.freedesktop.org/mesa/mesa/commit/?id=af30987a69848795d700357c3190b5adf44749fa

Author: Brian Paul <brianp at vmware.com>
Date:   Fri May  3 19:00:07 2013 -0600

vbo: update comments for vbo_save_NotifyBegin()

Reviewed-by: José Fonseca <jfonseca at vmware.com>

---

 src/mesa/vbo/vbo_save_api.c |   12 ++++++++++--
 1 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/src/mesa/vbo/vbo_save_api.c b/src/mesa/vbo/vbo_save_api.c
index 04904e1..a18d11d 100644
--- a/src/mesa/vbo/vbo_save_api.c
+++ b/src/mesa/vbo/vbo_save_api.c
@@ -924,8 +924,10 @@ _save_CallLists(GLsizei n, GLenum type, const GLvoid * v)
 
 
 
-/* This begin is hooked into ...  Updating of
- * ctx->Driver.CurrentSavePrimitive is already taken care of.
+/**
+ * Called via ctx->Driver.NotifySaveBegin() when a glBegin is getting
+ * compiled into a display list.
+ * Updating of ctx->Driver.CurrentSavePrimitive is already taken care of.
  */
 GLboolean
 vbo_save_NotifyBegin(struct gl_context *ctx, GLenum mode)
@@ -953,7 +955,13 @@ vbo_save_NotifyBegin(struct gl_context *ctx, GLenum mode)
    else {
       _mesa_install_save_vtxfmt(ctx, &save->vtxfmt);
    }
+
+   /* We need to call SaveFlushVertices() if there's state change */
    ctx->Driver.SaveNeedFlush = 1;
+
+   /* GL_TRUE means we've handled this glBegin here; don't compile a BEGIN
+    * opcode into the display list.
+    */
    return GL_TRUE;
 }