Skip to content

Commit 34fa61e

Browse files
committed
docs: clarify that tracking all setup files is intentional (safe due to hash check)
1 parent 7904482 commit 34fa61e

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

src/specify_cli/agent_pack.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,13 +347,20 @@ def finalize_setup(
347347
348348
All files returned by ``setup()`` are tracked — including shared
349349
project infrastructure — so that teardown/switch can precisely
350-
remove everything the agent installed.
350+
remove everything the agent installed. This is intentional:
351+
``remove_tracked_files()`` only deletes files whose SHA-256
352+
hash still matches the original, so user-modified files are
353+
always preserved (unless ``--force`` is used).
351354
352355
Args:
353356
agent_files: Files reported by :meth:`setup`.
354357
extension_files: Files created by extension registration.
355358
"""
356359
all_extension = list(extension_files or [])
360+
# Track ALL files returned by setup(), not just those under the
361+
# agent's directory tree. This is safe because teardown only
362+
# removes files that are unmodified (hash check) and prompts
363+
# for confirmation on modified files.
357364
all_agent: List[Path] = list(agent_files or [])
358365

359366
# Scan the agent's directory tree for files created by later

0 commit comments

Comments
 (0)