Merge pull request #988 from not-my-profile/fix-gix-config-sub

fix(docs): fix incorrect s/git-config/gix-config/

Author: Byron

DEVELOPMENT.md

@@ -79,7 +79,7 @@ There is value in organizing commits by topic and [_Stacked Git_](https://stacke
 
 ## Configuration and overrides
 
-As a general rule, respect and implement all applicable [gix-config](https://git-scm.com/docs/gix-config) by default, but allow the
+As a general rule, respect and implement all applicable [git-config](https://git-scm.com/docs/git-config) by default, but allow the
 caller to set overrides. How overrides work depends on the goals of the particular API so it can be done on the main call path,
 forcing a choice, or more typically, as a side-lane where overrides can be done on demand.
 

crate-status.md

@@ -621,7 +621,7 @@ See its [README.md](https://github.com/Byron/gitoxide/blob/main/gix-lock/README.
       * [x] run `git credential` directly
       * [x] use credential helper configuration and to obtain credentials with `gix_credentials::helper::Cascade`
     * **config**
-      * [ ] facilities to apply the [url-match](https://git-scm.com/docs/gix-config#Documentation/gix-config.txt-httplturlgt) algorithm and to
+      * [ ] facilities to apply the [url-match](https://git-scm.com/docs/git-config#Documentation/git-config.txt-httplturlgt) algorithm and to
             [normalize urls](https://github.com/git/git/blob/be1a02a17ede4082a86dfbfee0f54f345e8b43ac/urlmatch.c#L109:L109) before comparison.
     * **traverse** 
       * [x] commit graphs
@@ -714,7 +714,7 @@ See its [README.md](https://github.com/Byron/gitoxide/blob/main/gix-lock/README.
     * **config**
        * [x] read the primitive types `boolean`, `integer`, `string`
        * [x] read and interpolate trusted paths
-       * [x] low-level API for more elaborate access to all details of `gix-config` files
+       * [x] low-level API for more elaborate access to all details of `git-config` files
        * [ ] a way to make changes to individual configuration files
     * [x] mailmap   
     * [x] object replacements (`git replace`)

gix-config-value/Cargo.toml

@@ -3,7 +3,7 @@ name = "gix-config-value"
 version = "0.12.5"
 repository = "https://github.com/Byron/gitoxide"
 license = "MIT OR Apache-2.0"
-description = "A crate of the gitoxide project providing gix-config value parsing"
+description = "A crate of the gitoxide project providing git-config value parsing"
 authors = ["Sebastian Thiel <[email protected]>"]
 edition = "2021"
 rust-version = "1.65"

gix-config-value/src/color.rs

@@ -99,7 +99,7 @@ impl TryFrom<Cow<'_, BStr>> for Color {
 
 /// Discriminating enum for names of [`Color`] values.
 ///
-/// `gix-config` supports the eight standard colors, their bright variants, an
+/// `git-config` supports the eight standard colors, their bright variants, an
 /// ANSI color code, or a 24-bit hex value prefixed with an octothorpe/hash.
 #[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
 #[allow(missing_docs)]
@@ -232,7 +232,7 @@ impl TryFrom<&BStr> for Name {
 bitflags::bitflags! {
     /// Discriminating enum for [`Color`] attributes.
     ///
-    /// `gix-config` supports modifiers and their negators. The negating color
+    /// `git-config` supports modifiers and their negators. The negating color
     /// attributes are equivalent to having a `no` or `no-` prefix to the normal
     /// variant.
     #[derive(Default, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]

gix-config-value/src/integer.rs

@@ -87,7 +87,7 @@ impl TryFrom<Cow<'_, BStr>> for Integer {
     }
 }
 
-/// Integer suffixes that are supported by `gix-config`.
+/// Integer suffixes that are supported by `git-config`.
 ///
 /// These values are base-2 unit of measurements, not the base-10 variants.
 #[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]

gix-config-value/src/lib.rs

@@ -1,4 +1,4 @@
-//! Parsing for data types used in `gix-config` files to allow their use from environment variables and other sources.
+//! Parsing for data types used in `git-config` files to allow their use from environment variables and other sources.
 //!
 //! ## Feature Flags
 #![cfg_attr(

gix-config-value/src/types.rs

@@ -4,7 +4,7 @@ use crate::{color, integer};
 /// collection of color (text) modifiers, or a combination of any of the
 /// aforementioned values, like `red` or `brightgreen`.
 ///
-/// Note that `gix-config` allows color values to simply be a collection of
+/// Note that `git-config` allows color values to simply be a collection of
 /// [`color::Attribute`]s, and does not require a [`color::Name`] for either the
 /// foreground or background color.
 #[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]

gix-config/Cargo.toml

@@ -2,11 +2,11 @@
 name = "gix-config"
 version = "0.27.0"
 repository = "https://github.com/Byron/gitoxide"
-description = "A gix-config file parser and editor from the gitoxide project"
+description = "A git-config file parser and editor from the gitoxide project"
 license = "MIT OR Apache-2.0"
 authors = ["Edward Shen <[email protected]>"]
 edition = "2021"
-keywords = ["gix-config", "git", "config", "gitoxide"]
+keywords = ["git-config", "git", "config", "gitoxide"]
 categories = ["config", "parser-implementations"]
 include = ["src/**/*", "LICENSE-*", "README.md", "CHANGELOG.md"]
 rust-version = "1.65"

gix-config/README.md

@@ -1,9 +1,9 @@
 # gix-config
 
-**gix-config is a library for interacting with `gix-config` files.**
+**gix-config is a library for interacting with `git-config` files.**
 
 This crate intents to be a performant Rust implementation for reading and
-writing `gix-config` files. It exposes tiers of abstractions, from simple
+writing `git-config` files. It exposes tiers of abstractions, from simple
 config value wrappers to a high level reader and writer.
 
 The highlight of this crate is the zero-copy parser. We employ techniques to

gix-config/src/file/access/mutate.rs

@@ -130,10 +130,10 @@ impl<'event> File<'event> {
     /// # use std::borrow::Cow;
     /// # use gix_config::File;
     /// # use std::convert::TryFrom;
-    /// let mut gix_config = gix_config::File::default();
-    /// let section = gix_config.new_section("hello", Some(Cow::Borrowed("world".into())))?;
+    /// let mut git_config = gix_config::File::default();
+    /// let section = git_config.new_section("hello", Some(Cow::Borrowed("world".into())))?;
     /// let nl = section.newline().to_owned();
-    /// assert_eq!(gix_config.to_string(), format!("[hello \"world\"]{nl}"));
+    /// assert_eq!(git_config.to_string(), format!("[hello \"world\"]{nl}"));
     /// # Ok::<(), Box<dyn std::error::Error>>(())
     /// ```
     ///
@@ -145,13 +145,13 @@ impl<'event> File<'event> {
     /// # use std::convert::TryFrom;
     /// # use bstr::ByteSlice;
     /// # use gix_config::parse::section;
-    /// let mut gix_config = gix_config::File::default();
-    /// let mut section = gix_config.new_section("hello", Some(Cow::Borrowed("world".into())))?;
+    /// let mut git_config = gix_config::File::default();
+    /// let mut section = git_config.new_section("hello", Some(Cow::Borrowed("world".into())))?;
     /// section.push(section::Key::try_from("a")?, Some("b".into()));
     /// let nl = section.newline().to_owned();
-    /// assert_eq!(gix_config.to_string(), format!("[hello \"world\"]{nl}\ta = b{nl}"));
-    /// let _section = gix_config.new_section("core", None);
-    /// assert_eq!(gix_config.to_string(), format!("[hello \"world\"]{nl}\ta = b{nl}[core]{nl}"));
+    /// assert_eq!(git_config.to_string(), format!("[hello \"world\"]{nl}\ta = b{nl}"));
+    /// let _section = git_config.new_section("core", None);
+    /// assert_eq!(git_config.to_string(), format!("[hello \"world\"]{nl}\ta = b{nl}[core]{nl}"));
     /// # Ok::<(), Box<dyn std::error::Error>>(())
     /// ```
     pub fn new_section(
@@ -177,13 +177,13 @@ impl<'event> File<'event> {
     /// ```
     /// # use gix_config::File;
     /// # use std::convert::TryFrom;
-    /// let mut gix_config = gix_config::File::try_from(
+    /// let mut git_config = gix_config::File::try_from(
     /// r#"[hello "world"]
     ///     some-value = 4
     /// "#)?;
     ///
-    /// let section = gix_config.remove_section("hello", Some("world".into()));
-    /// assert_eq!(gix_config.to_string(), "");
+    /// let section = git_config.remove_section("hello", Some("world".into()));
+    /// assert_eq!(git_config.to_string(), "");
     /// # Ok::<(), Box<dyn std::error::Error>>(())
     /// ```
     ///
@@ -192,15 +192,15 @@ impl<'event> File<'event> {
     /// ```
     /// # use gix_config::File;
     /// # use std::convert::TryFrom;
-    /// let mut gix_config = gix_config::File::try_from(
+    /// let mut git_config = gix_config::File::try_from(
     /// r#"[hello "world"]
     ///     some-value = 4
     /// [hello "world"]
     ///     some-value = 5
     /// "#)?;
     ///
-    /// let section = gix_config.remove_section("hello", Some("world".into()));
-    /// assert_eq!(gix_config.to_string(), "[hello \"world\"]\n    some-value = 4\n");
+    /// let section = git_config.remove_section("hello", Some("world".into()));
+    /// assert_eq!(git_config.to_string(), "[hello \"world\"]\n    some-value = 4\n");
     /// # Ok::<(), Box<dyn std::error::Error>>(())
     /// ```
     pub fn remove_section<'a>(