89d738beff2c63765e2b6b4bc89412c621246b33
max
  Thu Sep 3 12:25:02 2026 -0700
snapshotSession: rename the snapshot "reaper" to "cleaner"

Renames the snapshotReaper utility to snapshotCleaner and drops the word
"reap" from the API and comments (snapshotReapAnon -> snapshotCleanAnon, and
the doc/usage text now say clean/cleaned/cleaner).  No behavior change.

refs #38197

diff --git src/hg/inc/snapshotSession.h src/hg/inc/snapshotSession.h
index 5b6d57c3309..9bb0d1b967f 100644
--- src/hg/inc/snapshotSession.h
+++ src/hg/inc/snapshotSession.h
@@ -1,48 +1,48 @@
 /* snapshotSession - lightweight, shareable "view snapshot" sessions.
  *
  * A snapshot is a minimal named session in the central namedSessionDb.  Unlike a normal saved
  * session (which stores the whole cart), a snapshot stores ONLY the handful of cart variables a
  * feature needs to reconstruct one specific view - e.g. a single BLAT alignment - and moves only
  * those variables' backing trash files into durable sessionData storage.  This keeps the row tiny
  * and, crucially, avoids leaking the sharer's unrelated tracks/position to whoever opens the link.
  *
  * Snapshots are always shared-by-link.  Their session names are prefixed "__" so the My Sessions
- * list can hide them by default and a reaper can garbage-collect abandoned anonymous ones.  Each
+ * list can hide them by default and the snapshot cleaner can remove abandoned anonymous ones.  Each
  * feature that wants durable shareable links registers a snapshotType naming its variables; the
- * feature reconstructs its view from those variables and calls snapshotTouchLastUse() on every open
- * so popular links stay alive under the reaper's "durable while used" policy.
+ * feature reconstructs its view from those variables, and the existing session-load path bumps
+ * lastUse on every open so popular links stay alive under the "durable while used" policy.
  *
  * Copyright (C) 2026 The Regents of the University of California
  * See kent/LICENSE or http://genome.ucsc.edu/license/ for licensing information. */
 
 #ifndef SNAPSHOTSESSION_H
 #define SNAPSHOTSESSION_H
 
 #include "cart.h"
 #include "jksql.h"
 
 /* All snapshot session names start with this marker: hidden from the session list by default and
- * eligible for TTL reaping.  A single leading '_' is reserved for real, user-visible auto-named
+ * eligible for TTL cleaning.  A single leading '_' is reserved for real, user-visible auto-named
  * quick shares; the double '__' means "machine-made, not a normal loadable session". */
 #define snapshotNamePrefix "__"
 
 /* Reserved userName for logged-out (anonymous) snapshots, matching doSaveSessionJson's convention
  * and the /s/l/<name> short link. */
 #define snapshotAnonUser "l"
 
-/* Default reaper TTL: an anonymous snapshot not opened within this many days is garbage-collected.
+/* Default cleaner TTL: an anonymous snapshot not opened within this many days is deleted.
  * 4 years ~ the length of a typical PhD, so a link in a thesis keeps working for its author's degree.
  * Override with the hg.conf setting "snapshot.ttlDays". */
 #define snapshotDefaultTtlDays (4 * 365)
 
 struct snapshotType
 /* A registered kind of shareable view snapshot: the cart variables a given feature needs to
  * reconstruct one of its views.  Register one per feature and keep the list minimal. */
     {
     char *name;         /* type key sent by the client, e.g. "blat" */
     char **vars;        /* NULL-terminated cart variable names to persist (besides "db") */
     };
 
 struct snapshotType *snapshotTypeFind(char *name);
 /* Return the registered snapshot type, or NULL if name is not a known type. */
 
@@ -53,21 +53,21 @@
 /* Alloc and return a fresh "__"-prefixed snapshot name, server-generated and checked against
  * namedSessionDb so it is guaranteed unique for encUserName (share tokens must never collide and
  * overwrite each other).  The token is long (128 bits) and URL-safe, so it needs no CGI-encoding. */
 
 int saveSnapshotSession(struct sqlConnection *conn, char *snapshotTypeName,
                         char *encUserName, char *encSessionName, struct cart *cart);
 /* Save a minimal shared-by-link session named encSessionName (which must already start with "__")
  * under encUserName, holding only the variables declared by snapshotTypeName (plus "db"), and moving
  * just those variables' trash files into durable sessionData storage when it is configured.
  * Overwrites any existing row of that name, preserving its firstUse/useCount.  errAborts on an
  * unknown type or a name lacking the "__" prefix.  Returns the (post-increment) useCount. */
 
 /* Note: no explicit "touch lastUse" is needed - cartLoadUserSession() already bumps lastUse (via
  * sessionTouchLastUse) on every session open, so a link stays alive as long as it is used. */
 
-int snapshotReapAnon(struct sqlConnection *conn, int ttlDays, boolean dryRun);
+int snapshotCleanAnon(struct sqlConnection *conn, int ttlDays, boolean dryRun);
 /* Delete anonymous ("l") snapshot rows whose lastUse is older than ttlDays, and remove their durable
  * sessionData directories.  Never touches non-anonymous or non-snapshot rows.  Returns the count
- * reaped (or that would be reaped, when dryRun). */
+ * cleaned (or that would be cleaned, when dryRun). */
 
 #endif /* SNAPSHOTSESSION_H */