1
0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-03-03 14:32:22 +02:00

doc: Explain that require_git(false) will ascend above git roots

Helps avoid confusion about #2812
This commit is contained in:
Martin Pool 2024-11-23 11:15:32 -08:00
parent 79cbe89deb
commit 0f0503d834

View File

@ -798,6 +798,10 @@ impl WalkBuilder {
/// ///
/// When disabled, git-related ignore rules are applied even when searching /// When disabled, git-related ignore rules are applied even when searching
/// outside a git repository. /// outside a git repository.
///
/// In particular, if this is `false` then `.gitignore` files will be read
/// from parent directories above the git root directory containing `.git`,
/// which is different from the git behavior.
pub fn require_git(&mut self, yes: bool) -> &mut WalkBuilder { pub fn require_git(&mut self, yes: bool) -> &mut WalkBuilder {
self.ig_builder.require_git(yes); self.ig_builder.require_git(yes);
self self