From 99b7957122454185dc5ea9e99bb1b56c8966f1a2 Mon Sep 17 00:00:00 2001
From: Martin Pool <mbp@sourcefrog.net>
Date: Sat, 23 Nov 2024 11:15:32 -0800
Subject: [PATCH] ignore/doc: explain that `require_git(false)` will ascend
 above git roots

This should hopefully help avoid confusion about #2812 as encountered
in https://github.com/sourcefrog/cargo-mutants/issues/450.

Closes #2937
---
 crates/ignore/src/walk.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/crates/ignore/src/walk.rs b/crates/ignore/src/walk.rs
index 448e599e..15494676 100644
--- a/crates/ignore/src/walk.rs
+++ b/crates/ignore/src/walk.rs
@@ -798,6 +798,10 @@ impl WalkBuilder {
     ///
     /// When disabled, git-related ignore rules are applied even when searching
     /// 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 {
         self.ig_builder.require_git(yes);
         self