gitoxide/lib.rs
1//! This is the documentation of the binaries that come with `gitoxide`. These are called `gix` and `ein`.
2//!
3//! #### `gix`
4//!
5//! A developer tool to allow using `gitoxide` algorithms and functionality outside of the test suite. It will be unstable as long as
6//! the `gix` crate is unstable and is explicitly not to be understood as `git` replacement.
7//!
8//! #### `ein`
9//!
10//! A program to eventually become the most convenient way to do typical operations on `git` repositories, with all tooling one typically
11//! needs built right into it.
12//! For now, it's most useful for its assorted set of `tools` which help to build automations or learn something about `git` repositories.
13//!
14//! ## Feature Flags
15//!
16//! Feature configuration can be complex and this document seeks to provide an overview.
17//!
18#![cfg_attr(
19 all(doc, feature = "document-features"),
20 doc = ::document_features::document_features!()
21)]
22#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg))]
23#![deny(rust_2018_idioms)]
24#![allow(missing_docs)]
25#![deny(unsafe_code)]
26
27pub mod plumbing;
28pub mod porcelain;
29/// everything in common between the `gix` and `ein` binaries.
30pub mod shared;