403e6092c8f4d9bd86c8f78292677997a9adcf89
jcasper
  Mon Aug 12 15:04:16 2024 -0700
Adding warning about changing hReplaceGbdb affecting straw, refs #27851

diff --git src/hg/inc/hdb.h src/hg/inc/hdb.h
index 57b2c70..6eee5c1 100644
--- src/hg/inc/hdb.h
+++ src/hg/inc/hdb.h
@@ -206,31 +206,37 @@
 /* Return TRUE if a table exists in database. */
 
 boolean hTableOrSplitExists(char *db, char *table);
 /* Return TRUE if table (or a chrN_table) exists in database. */
 
 char *hTableForTrack(char *db, char *trackName);
 /* Return a table for a track in db. Returns one of the split
  * tables, or main table if not split */
 
 char *hReplaceGbdbLocal(char* fileName);
  /* Returns a gbdb filename, potentially rewriting it according to hg.conf's gbdbLoc1 */
  /* Result has to be freed */
 
 char *hReplaceGbdb(char* fileName);
 /* clone and change a filename that can be located in /gbdb to somewhere else
- * according to hg.conf's "gbdbLoc1" and "gbdbLoc2". Result has to be freed. */
+ * according to hg.conf's "gbdbLoc1" and "gbdbLoc2". Result has to be freed.
+ *
+ * NB: This header is duplicated in hg/lib/straw/hReplaceGbdb.h so that it can be used
+ * in cStraw.cpp without wrestling with warnings about converting string data types
+ * in included library headers.  If this function signature changes, it will also need
+ * to be changed there.
+ * */
 
 char *hReplaceGbdbSeqDir(char *path, char *db);
 /* similar to hReplaceGbdb, but accepts a nib or 2bit "directory" (basename) under
  * gbdb, like /gbdb/hg19 (for jkLib that means /gbdb/hg19/hg19.2bit). */
 
 
 char* hReplaceGbdbMustDownload(char* path);
 /* given a location in /gbdb, rewrite it to the new location using gbdbLoc1 and download it
  * if needed from gbdbLoc2. */
 
 void hParseTableName(char *db, char *table, char trackName[HDB_MAX_TABLE_STRING],
 		     char chrom[HDB_MAX_CHROM_STRING]);
 /* Parse an actual table name like "chr17_random_blastzWhatever" into
  * the track name (blastzWhatever) and chrom (chr17_random). */