From 9ae249f53d07982e04017eb26cc976c99ec1c571 Mon Sep 17 00:00:00 2001
From: Eric Huss <eric@huss.org>
Date: Wed, 18 Dec 2024 09:06:45 -0800
Subject: [PATCH] Clarify disable_pathspec_match docs

---
 src/build.rs | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/build.rs b/src/build.rs
index 1cf3f98d96..4ac62439b7 100644
--- a/src/build.rs
+++ b/src/build.rs
@@ -491,7 +491,8 @@ impl<'cb> CheckoutBuilder<'cb> {
         self.flag(raw::GIT_CHECKOUT_CONFLICT_STYLE_DIFF3, on)
     }
 
-    /// Treat paths as a simple list.
+    /// Treat paths specified in [`CheckoutBuilder::path`] as exact file paths
+    /// instead of as pathspecs.
     pub fn disable_pathspec_match(&mut self, on: bool) -> &mut CheckoutBuilder<'cb> {
         self.flag(raw::GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH, on)
     }
@@ -520,8 +521,13 @@ impl<'cb> CheckoutBuilder<'cb> {
 
     /// Add a path to be checked out.
     ///
+    /// The path is a [pathspec] pattern, unless
+    /// [`CheckoutBuilder::disable_pathspec_match`] is set.
+    ///
     /// If no paths are specified, then all files are checked out. Otherwise
     /// only these specified paths are checked out.
+    ///
+    /// [pathspec]: https://git-scm.com/docs/gitglossary.html#Documentation/gitglossary.txt-aiddefpathspecapathspec
     pub fn path<T: IntoCString>(&mut self, path: T) -> &mut CheckoutBuilder<'cb> {
         let path = util::cstring_to_repo_path(path).unwrap();
         self.path_ptrs.push(path.as_ptr());