src/hg/inc/hgRelate.h 1.17

Index: src/hg/inc/hgRelate.h
===================================================================
RCS file: /projects/compbio/cvsroot/kent/src/hg/inc/hgRelate.h,v
retrieving revision 1.16
retrieving revision 1.17
diff -b -B -U 1000000 -r1.16 -r1.17
--- src/hg/inc/hgRelate.h	11 Oct 2008 20:17:35 -0000	1.16
+++ src/hg/inc/hgRelate.h	17 Feb 2010 08:53:20 -0000	1.17
@@ -1,85 +1,89 @@
 /*****************************************************************************
  * Copyright (C) 2000 Jim Kent.  This source code may be freely used         *
  * for personal, academic, and non-profit purposes.  Commercial use          *
  * permitted only by explicit agreement with Jim Kent (jim_kent@pacbell.net) *
  *****************************************************************************/
 /* hgRelate - Especially relational parts of browser data base. */
 #ifndef HGRELATE_H
 #define HGRELATE_H
 
 #ifndef DNASEQ_H
 #include "dnaseq.h"
 #endif 
 
 #ifndef UNFIN_H
 #include "unfin.h"
 #endif
 
 #ifndef JKSQL_H
 #include "jksql.h"
 #endif
 
 typedef unsigned int HGID;	/* A database ID. */
 
 HGID hgIdQuery(struct sqlConnection *conn, char *query);
 /* Return first field of first table as HGID. 0 return ok. */
 
 HGID hgRealIdQuery(struct sqlConnection *conn, char *query);
 /* Return first field of first table as HGID- abort if 0. */
 
 void hgHistoryComment(struct sqlConnection *conn, char *comment, ...);
 /* Add comment to history table.  Does not lock the process. */
 
 struct sqlConnection *hgStartUpdate(char *db);
 /* Open and connection and get next global id from the history table */
 
 void hgEndUpdate(struct sqlConnection **pConn, char *comment, ...);
 /* Finish up connection with a printf format comment. */
 
 HGID hgNextId(void);
 /* Get next unique id.  (Should only be called after hgStartUpdate). */
 
 FILE *hgCreateTabFile(char *tmpDir, char *tableName);
-/* Open a tab file with name corresponding to tableName in tmpDir. */
+/* Open a tab file with name corresponding to tableName in tmpDir.  If tmpDir is NULL,
+ * use TMPDIR environment, or "/var/tmp" */
 
 int hgUnlinkTabFile(char *tmpDir, char *tableName);
-/* Unlink tab file */
+/* Unlink tab file.   If tmpDir is NULL, use TMPDIR environment, or "/var/tmp" */
 
 void hgLoadTabFile(struct sqlConnection *conn, char *tmpDir, char *tableName,
                    FILE **tabFh);
-/* Load tab delimited file corresponding to tableName. close fh if not NULL */
+/* Load tab delimited file corresponding to tableName. close fh if not NULL.
+ * If tmpDir is NULL, use TMPDIR environment, or "/var/tmp"*/
 
 void hgLoadNamedTabFile(struct sqlConnection *conn, char *tmpDir, char *tableName,
                         char *fileName, FILE **tabFh);
-/* Load named tab delimited file corresponding to tableName. close fh if not NULL */
+/* Load named tab delimited file corresponding to tableName. close fh if not
+ * NULL If tmpDir is NULL, use TMPDIR environment, or "/var/tmp"*/
 
 void hgLoadTabFileOpts(struct sqlConnection *conn, char *tmpDir, char *tableName,
                        unsigned options, FILE **tabFh);
 /* Load tab delimited file corresponding to tableName. close tabFh if not NULL
- * Options are those supported by sqlLoadTabFile */
+ * If tmpDir is NULL, use TMPDIR environment, or "/var/tmp". Options are those
+ * supported by sqlLoadTabFile */
 
 void hgRemoveTabFile(char *tmpDir, char *tableName);
-/* Remove file. */
+/* Remove file.* If tmpDir is NULL, use TMPDIR environment, or "/var/tmp" */
 
 HGID hgGetMaxId(struct sqlConnection *conn, char *tableName);
 /* get the maximum value of the id column in a table or zero if empry  */
 
 int hgAddToExtFileTbl(char *path, struct sqlConnection *conn, char *extFileTbl);
 /* Add entry to the specified extFile table.  Delete it if it already exists.
  * Returns extFile id. */
 
 int hgAddToExtFile(char *path, struct sqlConnection *conn);
 /* Add entry to ext file table.  Delete it if it already exists. 
  * Returns extFile id. */
 
 void hgPurgeExtFileTbl(int id, struct sqlConnection *conn, char *extFileTbl);
 /* remove an entry from the extFile table.  Called
  * when there is an error loading the referenced file
  */
 
 void hgPurgeExtFile(int id, struct sqlConnection *conn);
 /* remove an entry from the extFile table.  Called
  * when there is an error loading the referenced file
  */
 #endif /* HGRELATE_H */