CVS commit: pkgsrc/security/keychain/files

["Paolo Vincenzo Olivo" <vins%netbsd.org@localhost>]

Module Name:    pkgsrc
Committed By:   vins
Date:           Sat Nov  8 17:32:20 UTC 2025

Modified Files:
        pkgsrc/security/keychain/files: README.pkgsrc startkeychain.sh

Log Message:
keychain: add some comments (NFC)


To generate a diff of this commit:
cvs rdiff -u -r1.2 -r1.3 pkgsrc/security/keychain/files/README.pkgsrc
cvs rdiff -u -r1.4 -r1.5 pkgsrc/security/keychain/files/startkeychain.sh

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

Modified files:

Index: pkgsrc/security/keychain/files/README.pkgsrc
diff -u pkgsrc/security/keychain/files/README.pkgsrc:1.2 pkgsrc/security/keychain/files/README.pkgsrc:1.3
--- pkgsrc/security/keychain/files/README.pkgsrc:1.2    Sat Nov  8 15:55:48 2025
+++ pkgsrc/security/keychain/files/README.pkgsrc        Sat Nov  8 17:32:20 2025
@@ -37,9 +37,9 @@ GPGKEYS
        single key ID or a space separated list of key IDs. If GPGKEYS is
        unset, startkeychain will not attempt to load any.
 
-Defaults my be overridden by either setting these variable in a local
-session or inside a dedicated ~/.keychainrc configuration file. An
-example ~/.keychainrc may look as follows:
+Defaults my be overridden by either setting these variables on the 
+command line or inside a dedicated ~/.keychainrc configuration file. 
+An example ~/.keychainrc may look as follows:
 
 KCHOPTS="--gpg2 --noask"
 SSHKEYS="netbsd_rsa user_ed25519"

Index: pkgsrc/security/keychain/files/startkeychain.sh
diff -u pkgsrc/security/keychain/files/startkeychain.sh:1.4 pkgsrc/security/keychain/files/startkeychain.sh:1.5
--- pkgsrc/security/keychain/files/startkeychain.sh:1.4 Sat Nov  8 16:55:52 2025
+++ pkgsrc/security/keychain/files/startkeychain.sh     Sat Nov  8 17:32:20 2025
@@ -27,6 +27,8 @@ case $1 in
         exit 2 ;;
 esac
 
+# Files where keychain stores the updated environment for SSH and - 
+# GPG agents. 
 ssh_env="${HOME}/.keychain/${HOSTNAME}-sh"
 gpg_env="${HOME}/.keychain/${HOSTNAME}-sh-gpg"
 
@@ -38,8 +40,10 @@ if [ -z "$SSHKEYS" ] && [ -z "$GPGKEYS" 
     "Use the SSHKEYS and GPGKEYS envinromental variables to specify one or more key to load."
     exit 1
 else
-    # Otherwise load both SSHKEYS and GPGKEYS
+    # Otherwise load both SSHKEYS and GPGKEYS.
     keychain $KCHOPTS $SSHKEYS $GPGKEYS
+    # Update environment. NOTE: This will only work if startkeychain is -
+    # sourced within a shell start-up script.
     for file in "$ssh_env" "$gpg_env"; do
         [ -f "$file" ] && . $file
     done