-
-
Notifications
You must be signed in to change notification settings - Fork 301
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add pro-forma libaray to allow feature documentation of `gitoxi…
…de` on docs.rs
- Loading branch information
Showing
3 changed files
with
80 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
//! This is the documentation of the binaries that come with `gitoxide`. These are called… | ||
//! | ||
//! #### `gix` | ||
//! | ||
//! A developer tool to allow using `gitoxide` algorithms and functionality outside of the test suite. It will be unstable as long as | ||
//! the `gix` crate is unstable and is explicitly not to be understood as `git` replacement. | ||
//! | ||
//! #### `ein` | ||
//! | ||
//! A program to eventually become the most convenient way to do typical operations on `git` repositories, with all tooling one typically | ||
//! needs built right into it. | ||
//! For now, it's most useful for its assorted set of `tools` which help to build automations or learn something about `git` repositories. | ||
//! | ||
//! ## Feature Flags | ||
//! | ||
//! Feature configuration can be complex and this document seeks to provide an overview. | ||
//! | ||
#![cfg_attr( | ||
feature = "document-features", | ||
cfg_attr(doc, doc = ::document_features::document_features!()) | ||
)] | ||
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))] | ||
#![deny(rust_2018_idioms, missing_docs)] | ||
#![forbid(unsafe_code)] |