Improvements to comments in build.c. (CVS 3149)

FossilOrigin-Name: 986208a364ce0ba81456b54e6561a277fb19309c

src/build.c

@@ -22,7 +22,7 @@
 **     COMMIT
 **     ROLLBACK
 **
-** $Id: build.c,v 1.391 2006/03/13 12:54:10 drh Exp $
+** $Id: build.c,v 1.392 2006/03/23 23:33:27 drh Exp $
 */
 #include "sqliteInt.h"
 #include <ctype.h>
@@ -42,26 +42,28 @@ void sqlite3BeginParse(Parse *pParse, int explainFlag){
 ** codeTableLocks() functions.
 */
 struct TableLock {
-  int iDb;
-  int iTab;
-  u8 isWriteLock;
-  const char *zName;
+  int iDb;             /* The database containing the table to be locked */
+  int iTab;            /* The root page of the table to be locked */
+  u8 isWriteLock;      /* True for write lock.  False for a read lock */
+  const char *zName;   /* Name of the table */
 };
 
 /*
-** Have the compiled statement lock the table with rootpage iTab in database
-** iDb at the shared-cache level when executed. The isWriteLock argument 
-** is zero for a read-lock, or non-zero for a write-lock.
+** Record the fact that we want to lock a table at run-time.  
 **
-** The zName parameter should point to the unqualified table name. This is
-** used to provide a more informative error message should the lock fail.
+** The table to be locked has root page iTab and is found in database iDb.
+** A read or a write lock can be taken depending on isWritelock.
+**
+** This routine just records the fact that the lock is desired.  The
+** code to make the lock occur is generated by a later call to
+** codeTableLocks() which occurs during sqlite3FinishCoding().
 */
 void sqlite3TableLock(
-  Parse *pParse, 
-  int iDb, 
-  int iTab, 
-  u8 isWriteLock,  
-  const char *zName
+  Parse *pParse,     /* Parsing context */
+  int iDb,           /* Index of the database containing the table to lock */
+  int iTab,          /* Root page number of the table to be locked */
+  u8 isWriteLock,    /* True for a write lock */
+  const char *zName  /* Name of the table to be locked */
 ){
   int i;
   int nBytes;