lael-labs/gitoxide

gix/src/lib.rs+6−11

 //!
 //! ### `libgit2` API to `gix`
 //!
-//! This section is a 'striving to be complete' mapping from `libgit2` APIs to the respective methods in `gix`.
+//! This doc-aliases are used to help finding methods under a possibly changed name. Just search in the docs.
+//! Entering `git2` into the search field will also surface all methods with such annotations.
 //!
-//! * [`git2::Repository::open()`](https://docs.rs/git2/*/git2/struct.Repository.html#method.open) ➡ [`open()`]
+//! What follows is a list of methods you might be missing, along with workarounds if available.
-//! * [`git2::Repository::open_bare()`](https://docs.rs/git2/*/git2/struct.Repository.html#method.open_bare) ➡ ❌
+//! * [`git2::Repository::open_bare()`](https://docs.rs/git2/*/git2/struct.Repository.html#method.open_bare) ➡ ❌ - use [`open()`] and discard it is not bare.
-//! * [`git2::Repository::open_from_env()`](https://docs.rs/git2/*/git2/struct.Repository.html#method.open_from_env) ➡ [`ThreadSafeRepository::open_with_environment_overrides()`]
-//! * [`git2::Repository::open_ext()`](https://docs.rs/git2/*/git2/struct.Repository.html#method.open_ext) ➡ [`open_opts()`]
-//! * [`git2::Repository::revparse()`](https://docs.rs/git2/*/git2/struct.Repository.html#method.revparse) ➡ [`Repository::rev_parse()`]
-//! * [`git2::Repository::revparse_single()`](https://docs.rs/git2/*/git2/struct.Repository.html#method.revparse_single) ➡ [`Repository::rev_parse_single()`]
-//! * [`git2::Repository::revwalk()`](https://docs.rs/git2/*/git2/struct.Repository.html#method.revwalk) ➡ [`Repository::rev_walk()`]
 //! * [`git2::build::CheckoutBuilder::disable_filters()](https://docs.rs/git2/*/git2/build/struct.CheckoutBuilder.html#method.disable_filters) ➡ ❌ *(filters are always applied during checkouts)*
-//! * [`git2::Odb::read_header()`](https://docs.rs/git2/*/git2/struct.Odb.html#method.read_header) ➡ [`Repository::find_header()`]
-//! * [`git2::Repository::submodules()`](https://docs.rs/git2/*/git2/struct.Repository.html#method.submodules) ➡ [`Repository::submodules()`]
-//! * [`git2::Repository::submodules()`](https://docs.rs/git2/*/git2/struct.Repository.html#method.submodules) ➡ [`Repository::submodules()`]
 //! * [`git2::Repository::submodule_status()`](https://docs.rs/git2/*/git2/struct.Repository.html#method.submodule_status) ➡ [`Submodule::state()`] - status provides more information and conveniences though, and an actual worktree status isn't performed.
 //!
 //! ## Feature Flags
 /// See [`ThreadSafeRepository::open()`], but returns a [`Repository`] instead.
 #[allow(clippy::result_large_err)]
+#[doc(alias = "git2")]
 pub fn open(directory: impl Into<std::path::PathBuf>) -> Result<Repository, open::Error> {
     ThreadSafeRepository::open(directory).map(Into::into)
 }
 /// See [`ThreadSafeRepository::open_opts()`], but returns a [`Repository`] instead.
 #[allow(clippy::result_large_err)]
+#[doc(alias = "open_ext", alias = "git2")]
 pub fn open_opts(directory: impl Into<std::path::PathBuf>, options: open::Options) -> Result<Repository, open::Error> {
     ThreadSafeRepository::open_opts(directory, options).map(Into::into)
 }

gix/src/open/repository.rs+1−0

@@ -108,6 +108,7 @@ impl ThreadSafeRepository { · 107 unmodified lines
108	// TODO: The following vars should end up as overrides of the respective configuration values (see git-config).	108	// TODO: The following vars should end up as overrides of the respective configuration values (see git-config).
109	// GIT_PROXY_SSL_CERT, GIT_PROXY_SSL_KEY, GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED.	109	// GIT_PROXY_SSL_CERT, GIT_PROXY_SSL_KEY, GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED.
110	// GIT_PROXY_SSL_CAINFO, GIT_SSL_CIPHER_LIST, GIT_HTTP_MAX_REQUESTS, GIT_CURL_FTP_NO_EPSV,	110	// GIT_PROXY_SSL_CAINFO, GIT_SSL_CIPHER_LIST, GIT_HTTP_MAX_REQUESTS, GIT_CURL_FTP_NO_EPSV,
		111	#[doc(alias = "open_from_env", alias = "git2")]
111	pub fn open_with_environment_overrides(	112	pub fn open_with_environment_overrides(
112	fallback_directory: impl Into<PathBuf>,	113	fallback_directory: impl Into<PathBuf>,
113	trust_map: gix_sec::trust::Mapping<Options>,	114	trust_map: gix_sec::trust::Mapping<Options>,

gix/src/pathspec.rs+8−0

@@ -84,6 +84,14 @@ impl<'repo> Pathspec<'repo> { · 83 unmodified lines
84	/// Return the first [`Match`](search::Match) of `relative_path`, or `None`.	84	/// Return the first [`Match`](search::Match) of `relative_path`, or `None`.
85	/// Note that the match might [be excluded](search::Match::is_excluded()).	85	/// Note that the match might [be excluded](search::Match::is_excluded()).
86	/// `is_dir` is true if `relative_path` is a directory.	86	/// `is_dir` is true if `relative_path` is a directory.
		87	#[doc(
		88	alias = "match_diff",
		89	alias = "match_tree",
		90	alias = "match_index",
		91	alias = "match_workdir",
		92	alias = "matches_path",
		93	alias = "git2"
		94	)]
87	pub fn pattern_matching_relative_path<'a>(	95	pub fn pattern_matching_relative_path<'a>(
88	&mut self,	96	&mut self,
89	relative_path: impl Into<&'a BStr>,	97	relative_path: impl Into<&'a BStr>,

gix/src/repository/object.rs+1−0

@@ -39,6 +39,7 @@ impl crate::Repository { · 38 unmodified lines
39	/// Obtain information about an object without fully decoding it, or fail if the object doesn't exist.	39	/// Obtain information about an object without fully decoding it, or fail if the object doesn't exist.
40	///	40	///
41	/// Note that despite being cheaper than [`Self::find_object()`], there is still some effort traversing delta-chains.	41	/// Note that despite being cheaper than [`Self::find_object()`], there is still some effort traversing delta-chains.
		42	#[doc(alias = "read_header", alias = "git2")]
42	pub fn find_header(&self, id: impl Into<ObjectId>) -> Result<gix_odb::find::Header, object::find::existing::Error> {	43	pub fn find_header(&self, id: impl Into<ObjectId>) -> Result<gix_odb::find::Header, object::find::existing::Error> {
43	let id = id.into();	44	let id = id.into();
44	if id == gix_hash::ObjectId::empty_tree(self.object_hash()) {	45	if id == gix_hash::ObjectId::empty_tree(self.object_hash()) {

gix/src/repository/pathspec.rs+1−0

@@ -11,6 +11,7 @@ impl Repository { · 10 unmodified lines
11	///	11	///
12	/// It will be initialized exactly how it would, and attribute matching will be conducted by reading the worktree first if available.	12	/// It will be initialized exactly how it would, and attribute matching will be conducted by reading the worktree first if available.
13	/// If that is not desirable, consider calling [`Pathspec::new()`] directly.	13	/// If that is not desirable, consider calling [`Pathspec::new()`] directly.
		14	#[doc(alias = "Pathspec", alias = "git2")]
14	pub fn pathspec(	15	pub fn pathspec(
15	&self,	16	&self,
16	patterns: impl IntoIterator<Item = impl AsRef<BStr>>,	17	patterns: impl IntoIterator<Item = impl AsRef<BStr>>,

gix/src/repository/revision.rs+3−0

     ///
     /// - `@` actually stands for `HEAD`, whereas `git` resolves it to the object pointed to by `HEAD` without making the
     ///   `HEAD` ref available for lookups.
+    #[doc(alias = "revparse", alias = "git2")]
     pub fn rev_parse<'a>(&self, spec: impl Into<&'a BStr>) -> Result<revision::Spec<'_>, revision::spec::parse::Error> {
         revision::Spec::from_bstr(
             spec,
     }
     /// Parse a revision specification and return single object id as represented by this instance.
+    #[doc(alias = "revparse_single", alias = "git2")]
     pub fn rev_parse_single<'repo, 'a>(
         &'repo self,
         spec: impl Into<&'a BStr>,
     /// Create the baseline for a revision walk by initializing it with the `tips` to start iterating on.
     ///
     /// It can be configured further before starting the actual walk.
+    #[doc(alias = "revwalk", alias = "git2")]
     pub fn rev_walk(
         &self,
         tips: impl IntoIterator<Item = impl Into<gix_hash::ObjectId>>,

gix/src/repository/submodule.rs+1−0

@@ -73,6 +73,7 @@ impl Repository { · 72 unmodified lines
73	}	73	}
74		74
75	/// Return the list of available submodules, or `None` if there is no submodule configuration.	75	/// Return the list of available submodules, or `None` if there is no submodule configuration.
		76	#[doc(alias = "git2")]
76	pub fn submodules(&self) -> Result<Option<impl Iterator<Item = crate::Submodule<'_>>>, submodule::modules::Error> {	77	pub fn submodules(&self) -> Result<Option<impl Iterator<Item = crate::Submodule<'_>>>, submodule::modules::Error> {
77	let modules = match self.modules()? {	78	let modules = match self.modules()? {
78	None => return Ok(None),	79	None => return Ok(None),

gix/src/submodule/mod.rs+1−0

@@ -226,6 +226,7 @@ impl<'repo> Submodule<'repo> { · 225 unmodified lines
226	}	226	}
227		227
228	/// Query various parts of the submodule and assemble it into state information.	228	/// Query various parts of the submodule and assemble it into state information.
		229	#[doc(alias = "status", alias = "git2")]
229	pub fn state(&self) -> Result<State, config::path::Error> {	230	pub fn state(&self) -> Result<State, config::path::Error> {
230	let maybe_old_path = self.git_dir_try_old_form()?;	231	let maybe_old_path = self.git_dir_try_old_form()?;
231	let git_dir = self.git_dir();	232	let git_dir = self.git_dir();