diff --git a/src/index/git_remote.rs b/src/index/git_remote.rs index 15cf307..76e701d 100644 --- a/src/index/git_remote.rs +++ b/src/index/git_remote.rs @@ -20,15 +20,6 @@ impl RemoteGitIndex { /// /// Note that if a repository does not exist at the local disk path of the /// provided [`GitIndex`], a full clone will be performed. - /// - /// ## Locking - /// This function will wait to aquire the lock on the local directory for up to 10 minutes, - /// and then return `GitError::Lock` if it is still locked by another thread or process. - /// You can customize this behavior using [`Self::with_options`]. - /// - /// Regardless of the timeout, this function relies on `panic = unwind` to avoid leaving stale locks - /// if the process is interrupted with Ctrl+C. To support `panic = abort` you also need to register - /// the `gix` signal handler to clean up the locks, see [`gix::interrupt::init_handler`]. #[inline] pub fn new(index: GitIndex, lock: &FileLock) -> Result { Self::with_options( @@ -50,10 +41,6 @@ impl RemoteGitIndex { /// Creates a new [`Self`] that allows showing of progress of the the potential /// fetch if the disk location is empty, as well as allowing interruption /// of the fetch operation. - /// - /// Regardless of the `lock_policy`, this function relies on `panic = unwind` to avoid leaving stale locks - /// if the process is interrupted with Ctrl+C. To support `panic = abort` you also need to register - /// a signal handler that sets `should_interrupt` to `true`. pub fn with_options

( mut index: GitIndex, progress: P,