Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit c51c8da

Browse files
not-my-profilenot-my-profile
committed
fix(docs): fix incorrect s/git-config/gix-config/
3a861c8 just blindly replaced any occurence of "git-config" or "git_config" with "gix-config"/"gix_config". There is no such thing as a gix-config file. gix-config is a git-config file parser.
1 parent 66dadf8 commit c51c8da

32 files changed

Lines changed: 106 additions & 106 deletions

File tree

‎DEVELOPMENT.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ There is value in organizing commits by topic and [_Stacked Git_](https://stacke
7979

8080
## Configuration and overrides
8181

82-
As a general rule, respect and implement all applicable [gix-config](https://git-scm.com/docs/gix-config) by default, but allow the
82+
As a general rule, respect and implement all applicable [git-config](https://git-scm.com/docs/git-config) by default, but allow the
8383
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,
8484
forcing a choice, or more typically, as a side-lane where overrides can be done on demand.
8585

‎crate-status.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -621,7 +621,7 @@ See its [README.md](https://github.com/Byron/gitoxide/blob/main/gix-lock/README.
621621
* [x] run `git credential` directly
622622
* [x] use credential helper configuration and to obtain credentials with `gix_credentials::helper::Cascade`
623623
* **config**
624-
* [ ] facilities to apply the [url-match](https://git-scm.com/docs/gix-config#Documentation/gix-config.txt-httplturlgt) algorithm and to
624+
* [ ] facilities to apply the [url-match](https://git-scm.com/docs/git-config#Documentation/git-config.txt-httplturlgt) algorithm and to
625625
[normalize urls](https://github.com/git/git/blob/be1a02a17ede4082a86dfbfee0f54f345e8b43ac/urlmatch.c#L109:L109) before comparison.
626626
* **traverse**
627627
* [x] commit graphs
@@ -714,7 +714,7 @@ See its [README.md](https://github.com/Byron/gitoxide/blob/main/gix-lock/README.
714714
* **config**
715715
* [x] read the primitive types `boolean`, `integer`, `string`
716716
* [x] read and interpolate trusted paths
717-
* [x] low-level API for more elaborate access to all details of `gix-config` files
717+
* [x] low-level API for more elaborate access to all details of `git-config` files
718718
* [ ] a way to make changes to individual configuration files
719719
* [x] mailmap
720720
* [x] object replacements (`git replace`)

‎gix-config-value/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name = "gix-config-value"
33
version = "0.12.5"
44
repository = "https://github.com/Byron/gitoxide"
55
license = "MIT OR Apache-2.0"
6-
description = "A crate of the gitoxide project providing gix-config value parsing"
6+
description = "A crate of the gitoxide project providing git-config value parsing"
77
authors = ["Sebastian Thiel <[email protected]>"]
88
edition = "2021"
99
rust-version = "1.65"

‎gix-config-value/src/color.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ impl TryFrom<Cow<'_, BStr>> for Color {
9999

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

‎gix-config-value/src/integer.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ impl TryFrom<Cow<'_, BStr>> for Integer {
8787
}
8888
}
8989

90-
/// Integer suffixes that are supported by `gix-config`.
90+
/// Integer suffixes that are supported by `git-config`.
9191
///
9292
/// These values are base-2 unit of measurements, not the base-10 variants.
9393
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]

‎gix-config-value/src/lib.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Parsing for data types used in `gix-config` files to allow their use from environment variables and other sources.
1+
//! Parsing for data types used in `git-config` files to allow their use from environment variables and other sources.
22
//!
33
//! ## Feature Flags
44
#![cfg_attr(

‎gix-config-value/src/types.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ use crate::{color, integer};
44
/// collection of color (text) modifiers, or a combination of any of the
55
/// aforementioned values, like `red` or `brightgreen`.
66
///
7-
/// Note that `gix-config` allows color values to simply be a collection of
7+
/// Note that `git-config` allows color values to simply be a collection of
88
/// [`color::Attribute`]s, and does not require a [`color::Name`] for either the
99
/// foreground or background color.
1010
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]

‎gix-config/Cargo.toml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
name = "gix-config"
33
version = "0.27.0"
44
repository = "https://github.com/Byron/gitoxide"
5-
description = "A gix-config file parser and editor from the gitoxide project"
5+
description = "A git-config file parser and editor from the gitoxide project"
66
license = "MIT OR Apache-2.0"
77
authors = ["Edward Shen <[email protected]>"]
88
edition = "2021"
9-
keywords = ["gix-config", "git", "config", "gitoxide"]
9+
keywords = ["git-config", "git", "config", "gitoxide"]
1010
categories = ["config", "parser-implementations"]
1111
include = ["src/**/*", "LICENSE-*", "README.md", "CHANGELOG.md"]
1212
rust-version = "1.65"

‎gix-config/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# gix-config
22

3-
**gix-config is a library for interacting with `gix-config` files.**
3+
**gix-config is a library for interacting with `git-config` files.**
44

55
This crate intents to be a performant Rust implementation for reading and
6-
writing `gix-config` files. It exposes tiers of abstractions, from simple
6+
writing `git-config` files. It exposes tiers of abstractions, from simple
77
config value wrappers to a high level reader and writer.
88

99
The highlight of this crate is the zero-copy parser. We employ techniques to

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

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -130,10 +130,10 @@ impl<'event> File<'event> {
130130
/// # use std::borrow::Cow;
131131
/// # use gix_config::File;
132132
/// # use std::convert::TryFrom;
133-
/// let mut gix_config = gix_config::File::default();
134-
/// let section = gix_config.new_section("hello", Some(Cow::Borrowed("world".into())))?;
133+
/// let mut git_config = gix_config::File::default();
134+
/// let section = git_config.new_section("hello", Some(Cow::Borrowed("world".into())))?;
135135
/// let nl = section.newline().to_owned();
136-
/// assert_eq!(gix_config.to_string(), format!("[hello \"world\"]{nl}"));
136+
/// assert_eq!(git_config.to_string(), format!("[hello \"world\"]{nl}"));
137137
/// # Ok::<(), Box<dyn std::error::Error>>(())
138138
/// ```
139139
///
@@ -145,13 +145,13 @@ impl<'event> File<'event> {
145145
/// # use std::convert::TryFrom;
146146
/// # use bstr::ByteSlice;
147147
/// # use gix_config::parse::section;
148-
/// let mut gix_config = gix_config::File::default();
149-
/// let mut section = gix_config.new_section("hello", Some(Cow::Borrowed("world".into())))?;
148+
/// let mut git_config = gix_config::File::default();
149+
/// let mut section = git_config.new_section("hello", Some(Cow::Borrowed("world".into())))?;
150150
/// section.push(section::Key::try_from("a")?, Some("b".into()));
151151
/// let nl = section.newline().to_owned();
152-
/// assert_eq!(gix_config.to_string(), format!("[hello \"world\"]{nl}\ta = b{nl}"));
153-
/// let _section = gix_config.new_section("core", None);
154-
/// assert_eq!(gix_config.to_string(), format!("[hello \"world\"]{nl}\ta = b{nl}[core]{nl}"));
152+
/// assert_eq!(git_config.to_string(), format!("[hello \"world\"]{nl}\ta = b{nl}"));
153+
/// let _section = git_config.new_section("core", None);
154+
/// assert_eq!(git_config.to_string(), format!("[hello \"world\"]{nl}\ta = b{nl}[core]{nl}"));
155155
/// # Ok::<(), Box<dyn std::error::Error>>(())
156156
/// ```
157157
pub fn new_section(
@@ -177,13 +177,13 @@ impl<'event> File<'event> {
177177
/// ```
178178
/// # use gix_config::File;
179179
/// # use std::convert::TryFrom;
180-
/// let mut gix_config = gix_config::File::try_from(
180+
/// let mut git_config = gix_config::File::try_from(
181181
/// r#"[hello "world"]
182182
/// some-value = 4
183183
/// "#)?;
184184
///
185-
/// let section = gix_config.remove_section("hello", Some("world".into()));
186-
/// assert_eq!(gix_config.to_string(), "");
185+
/// let section = git_config.remove_section("hello", Some("world".into()));
186+
/// assert_eq!(git_config.to_string(), "");
187187
/// # Ok::<(), Box<dyn std::error::Error>>(())
188188
/// ```
189189
///
@@ -192,15 +192,15 @@ impl<'event> File<'event> {
192192
/// ```
193193
/// # use gix_config::File;
194194
/// # use std::convert::TryFrom;
195-
/// let mut gix_config = gix_config::File::try_from(
195+
/// let mut git_config = gix_config::File::try_from(
196196
/// r#"[hello "world"]
197197
/// some-value = 4
198198
/// [hello "world"]
199199
/// some-value = 5
200200
/// "#)?;
201201
///
202-
/// let section = gix_config.remove_section("hello", Some("world".into()));
203-
/// assert_eq!(gix_config.to_string(), "[hello \"world\"]\n some-value = 4\n");
202+
/// let section = git_config.remove_section("hello", Some("world".into()));
203+
/// assert_eq!(git_config.to_string(), "[hello \"world\"]\n some-value = 4\n");
204204
/// # Ok::<(), Box<dyn std::error::Error>>(())
205205
/// ```
206206
pub fn remove_section<'a>(

0 commit comments

Comments
 (0)