Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Byron committed Nov 17, 2022
1 parent c32663e commit b5c316e
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion git-protocol/src/fetch/delegate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ pub trait DelegateBlocking {
/// Note that some arguments are preset based on typical use, and `features` are preset to maximize options.
/// The `server` capabilities can be used to see which additional capabilities the server supports as per the handshake which happened prior.
///
/// If the delegate returns [`LsRefsAction::Skip`], no 'ls-refs` command is sent to the server.
/// If the delegate returns [`ls_refs::Action::Skip`], no 'ls-refs` command is sent to the server.
///
/// Note that this is called only if we are using protocol version 2.
fn prepare_ls_refs(
Expand Down
6 changes: 3 additions & 3 deletions git-protocol/src/ls_refs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ mod error {
}
pub use error::Error;

/// What to do after [`DelegateBlocking::prepare_ls_refs`].
/// What to do after preparing ls-refs in [ls_refs()][crate::ls_refs()].
#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
pub enum Action {
/// Continue by sending a 'ls-refs' command.
Continue,
/// Skip 'ls-refs' entirely.
///
/// This is valid if the 'ref-in-want' capability is taken advantage of. The delegate must then send 'want-ref's in
/// [`DelegateBlocking::negotiate`].
/// This is useful if the `ref-in-want` capability is taken advantage of. When fetching, one must must then send
/// `want-ref`s during the negotiation phase.
Skip,
}

Expand Down
2 changes: 1 addition & 1 deletion git-repository/src/env.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use crate::bstr::{BString, ByteVec};
/// Returns the name of the agent for identification towards a remote server as statically known when compiling the crate.
/// Suitable for both `git` servers and HTTP servers, and used unless configured otherwise.
///
/// Note that it's meant to be used in conjunction with [`protocol::fetch::agent()`][crate::protocol::fetch::agent()] which
/// Note that it's meant to be used in conjunction with [`protocol::agent()`][crate::protocol::agent()] which
/// prepends `git/`.
pub fn agent() -> &'static str {
concat!("oxide-", env!("CARGO_PKG_VERSION"))
Expand Down

0 comments on commit b5c316e

Please sign in to comment.