Skip to content

docs: document reporting directory concept and descent algorithm in README#22

Merged
dimalvovs merged 1 commit intomainfrom
copilot/update-readme-description-reporting-directory
Apr 11, 2026
Merged

docs: document reporting directory concept and descent algorithm in README#22
dimalvovs merged 1 commit intomainfrom
copilot/update-readme-description-reporting-directory

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 11, 2026

The README described group mode descent only vaguely ("descends until a directory containing at least one file is found") with no explanation of what a reporting directory is or how the ignore list interacts with descent.

Changes

  • New "Reporting Directory & Descent" section between "Operating Modes" and "Example Output" covering:
    • Definition of a reporting directory (first ancestor containing a visible, non-ignored file)
    • Step-by-step descent rules: stop on visible file → recurse on ignored-only/subdir-only → use empty leaf as-is → fall back to current dir if all subdirs are inaccessible
    • Ignore list semantics during descent: matched files are invisible (don't halt descent); matched subdirectories are skipped entirely and never become reporting directories
    • Concrete example clarifying that ['.*', '*.tmp'] causes ontrack to look past hidden dirs and dotfile-only directories

@dimalvovs dimalvovs marked this pull request as ready for review April 11, 2026 12:33
@dimalvovs dimalvovs merged commit 78bef43 into main Apr 11, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants