Repository navigation
Correct documented file selection modes - #356
Open
dajiaohuang wants to merge 1 commit into
Open
dajiaohuang wants to merge 1 commit into
dajiaohuang wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The usage table says
--include-ignoredincludes tracked and LFS-tracked files. Since #97, this mode usesgit ls-files --cached --exclude-standard --ignored --other, which selects ignored files instead: tracked sources are absent from the generated tags. The README also says the include options can be combined, whereas the implementation selects only one mode, in the order submodule → untracked → ignored.Change
Correct the existing table and mode-combination instructions to match the implemented behavior, without changing selection semantics. Correct the invalid
--ctags_optand--include_untrackedspellings to the actual long options.Validation
Verified against
--help,CmdGit::ls_files, and real CLI invocations on an isolated synthetic Git tree with tracked, untracked and ignored C sources.--include-ignoredproduces only the ignored symbol; combining it with--include-untrackedproduces tracked/untracked symbols instead. Also exercised a synthetic local submodule and real git-lfs pointer exclusion. Linux used Universal Ctags 5.9.0; the basic selection cases also ran with Universal Ctags 6.1.0 on Windows. A local documentation-contract check fails against the base README and passes after these corrections.git diff --checkpasses. No code behavior is changed.