Skip to content

Commit 9ae249f

Browse files
committed
Clarify disable_pathspec_match docs
1 parent 7db456d commit 9ae249f

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/build.rs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -491,7 +491,8 @@ impl<'cb> CheckoutBuilder<'cb> {
491491
self.flag(raw::GIT_CHECKOUT_CONFLICT_STYLE_DIFF3, on)
492492
}
493493

494-
/// Treat paths as a simple list.
494+
/// Treat paths specified in [`CheckoutBuilder::path`] as exact file paths
495+
/// instead of as pathspecs.
495496
pub fn disable_pathspec_match(&mut self, on: bool) -> &mut CheckoutBuilder<'cb> {
496497
self.flag(raw::GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH, on)
497498
}
@@ -520,8 +521,13 @@ impl<'cb> CheckoutBuilder<'cb> {
520521

521522
/// Add a path to be checked out.
522523
///
524+
/// The path is a [pathspec] pattern, unless
525+
/// [`CheckoutBuilder::disable_pathspec_match`] is set.
526+
///
523527
/// If no paths are specified, then all files are checked out. Otherwise
524528
/// only these specified paths are checked out.
529+
///
530+
/// [pathspec]: https://git-scm.com/docs/gitglossary.html#Documentation/gitglossary.txt-aiddefpathspecapathspec
525531
pub fn path<T: IntoCString>(&mut self, path: T) -> &mut CheckoutBuilder<'cb> {
526532
let path = util::cstring_to_repo_path(path).unwrap();
527533
self.path_ptrs.push(path.as_ptr());

0 commit comments

Comments
 (0)