Skip to content

Commit 5f7ba04

Browse files
docs: clarify symlink command behavior
Co-authored-by: CoderDeltaLAN <CoderDeltaLAN@users.noreply.github.com>
1 parent ef7e938 commit 5f7ba04

2 files changed

Lines changed: 9 additions & 0 deletions

File tree

docs/EXIT-CODES.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ Notes:
6666
- `budget` uses deterministic local metrics only.
6767
- `budget` does not perform tokenizer-specific counting, remote tokenization, LLM calls, pricing estimates, or optimization claims.
6868
- `Approximate words` is not a model token count.
69+
- Symlinked supported instruction-file paths fail hard with exit code `2` instead of being followed or silently skipped.
6970

7071
### `dedupe`
7172

@@ -80,6 +81,7 @@ Notes:
8081
- `dedupe` is read-only.
8182
- `dedupe` uses deterministic local normalization only.
8283
- `dedupe` detects repeated normalized lines across supported instruction files, not broad semantic duplication.
84+
- Symlinked supported instruction-file paths fail hard with exit code `2` instead of being followed or silently skipped.
8385

8486
### `conflicts`
8587

@@ -94,6 +96,7 @@ Notes:
9496
- `conflicts` is read-only.
9597
- `conflicts` uses deterministic local pattern families only.
9698
- `conflicts` detects implemented opposite-guidance patterns, not broad semantic contradiction.
99+
- Symlinked supported instruction-file paths fail hard with exit code `2` instead of being followed or silently skipped.
97100

98101
### `explain`
99102

docs/OUTPUTS.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,8 @@ Current `budget` exit-code behavior:
255255

256256
`Approximate words` is a local whitespace-based approximation, not a model token count.
257257

258+
Budget rejects symlinked supported instruction-file paths with exit code `2` instead of producing a partial report. This is deliberate: budget totals should not follow or count external symlink targets as if they were repository-local instruction files.
259+
258260
## Dedupe output contract
259261

260262
Current `dedupe` console output includes:
@@ -275,6 +277,8 @@ Current `dedupe` exit-code behavior:
275277

276278
`dedupe` is read-only. It detects repeated normalized lines across supported instruction files. It does not perform semantic duplication analysis.
277279

280+
Dedupe rejects symlinked supported instruction-file paths with exit code `2` instead of producing a partial report. This is deliberate: duplicate-line reports should compare repository-local instruction text and should not follow symlink targets outside the reviewed tree.
281+
278282
## Conflicts output contract
279283

280284
Current `conflicts` console output includes:
@@ -295,6 +299,8 @@ Current `conflicts` exit-code behavior:
295299

296300
`conflicts` is read-only. It detects implemented deterministic pattern families for opposite guidance. It does not perform broad semantic contradiction analysis.
297301

302+
Conflicts rejects symlinked supported instruction-file paths with exit code `2` instead of producing a partial report. This is deliberate: conflict reports should not mix repository-local guidance with symlink targets whose review boundary may be unclear.
303+
298304
## Explain output contract
299305

300306
Current `explain` console output includes either:

0 commit comments

Comments
 (0)