From 1163bd8f4e3c38b48244a1e15ff54a099c7a2e8e Mon Sep 17 00:00:00 2001
From: Zachary Lentz <zlentz@slac.stanford.edu>
Date: Wed, 24 Jul 2024 11:55:04 -0700
Subject: [PATCH] DOC: document the logout condition

---
 scripts/ssh-agent-helper | 1 +
 1 file changed, 1 insertion(+)

diff --git a/scripts/ssh-agent-helper b/scripts/ssh-agent-helper
index b4af416c..23188e3f 100644
--- a/scripts/ssh-agent-helper
+++ b/scripts/ssh-agent-helper
@@ -2,6 +2,7 @@
 #
 # Helper script for starting the ssh agent if needed and doing an ssh-add.
 # This will let anyone smoothly run github/ssh related scripts without multiple password prompts.
+# An ssh-agent instance set up using this script will be automaticalls closed on logout.
 #
 # This script is intended to be sourced.
 # Sourcing this script lets ssh-agent set the proper environment variables it needs to run properly.