fix!: rename GITOXIDE_* environment variables to GIX_#

Byron · Byron · commit 2189cee47f99 · 2023-12-06T13:09:41.000+01:00
diff --git a/build.rs b/build.rs
@@ -8,7 +8,7 @@ fn main() {
         .and_then(|out| parse_describe(&out.stdout))
         .unwrap_or_else(|| env!("CARGO_PKG_VERSION").into());
 
-    println!("cargo:rustc-env=GITOXIDE_VERSION={version}");
+    println!("cargo:rustc-env=GIX_VERSION={version}");
 }
 
 fn parse_describe(input: &[u8]) -> Option<String> {
diff --git a/examples/log.rs b/examples/log.rs
@@ -20,7 +20,7 @@ fn main() {
 }
 
 #[derive(Debug, clap::Parser)]
-#[clap(name = "log", about = "git log example", version = option_env!("GITOXIDE_VERSION"))]
+#[clap(name = "log", about = "git log example", version = option_env!("GIX_VERSION"))]
 struct Args {
     /// Alternative git directory to use
     #[clap(name = "dir", long = "git-dir")]
diff --git a/examples/ls-tree.rs b/examples/ls-tree.rs
@@ -12,7 +12,7 @@ fn main() {
 }
 
 #[derive(Debug, clap::Parser)]
-#[clap(name = "ls-tree", about = "git ls-tree example", version = option_env!("GITOXIDE_VERSION"))]
+#[clap(name = "ls-tree", about = "git ls-tree example", version = option_env!("GIX_VERSION"))]
 #[clap(arg_required_else_help = true)]
 struct Args {
     /// Recurse into subtrees
diff --git a/gix-discover/tests/upwards/mod.rs b/gix-discover/tests/upwards/mod.rs
@@ -3,7 +3,7 @@ use std::path::PathBuf;
 use gix_discover::repository::Kind;
 
 fn expected_trust() -> gix_sec::Trust {
-    if std::env::var_os("GITOXIDE_TEST_EXPECT_REDUCED_TRUST").is_some() {
+    if std::env::var_os("GIX_TEST_EXPECT_REDUCED_TRUST").is_some() {
         gix_sec::Trust::Reduced
     } else {
         gix_sec::Trust::Full
diff --git a/gix/src/config/tree/sections/core.rs b/gix/src/config/tree/sections/core.rs
@@ -17,7 +17,7 @@ impl Core {
     /// The `core.deltaBaseCacheLimit` key.
     pub const DELTA_BASE_CACHE_LIMIT: keys::UnsignedInteger =
         keys::UnsignedInteger::new_unsigned_integer("deltaBaseCacheLimit", &config::Tree::CORE)
-            .with_environment_override("GITOXIDE_PACK_CACHE_MEMORY")
+            .with_environment_override("GIX_PACK_CACHE_MEMORY")
             .with_note("if unset, we default to a small 64 slot fixed-size cache that holds at most 64 full delta base objects of any size. Set to 0 to deactivate it entirely");
     /// The `core.disambiguate` key.
     pub const DISAMBIGUATE: Disambiguate =
diff --git a/gix/src/config/tree/sections/gitoxide.rs b/gix/src/config/tree/sections/gitoxide.rs
@@ -410,7 +410,7 @@ mod subsections {
         pub const CACHE_LIMIT: keys::UnsignedInteger =
             keys::UnsignedInteger::new_unsigned_integer("cacheLimit", &Gitoxide::OBJECTS)
                 .with_note("If unset or 0, there is no object cache")
-                .with_environment_override("GITOXIDE_OBJECT_CACHE_MEMORY");
+                .with_environment_override("GIX_OBJECT_CACHE_MEMORY");
         /// The `gitoxide.objects.noReplace` key.
         pub const NO_REPLACE: keys::Boolean = keys::Boolean::new_boolean("noReplace", &Gitoxide::OBJECTS);
         /// The `gitoxide.objects.replaceRefBase` key.
diff --git a/gix/tests/config/tree.rs b/gix/tests/config/tree.rs
@@ -448,7 +448,7 @@ mod core {
                 .try_into_usize(signed(-1))
                 .unwrap_err()
                 .to_string(),
-            "The value of key \"core.deltaBaseCacheLimit\" (possibly from GITOXIDE_PACK_CACHE_MEMORY) could not be parsed as unsigned integer"
+            "The value of key \"core.deltaBaseCacheLimit\" (possibly from GIX_PACK_CACHE_MEMORY) could not be parsed as unsigned integer"
         );
         assert!(Core::DELTA_BASE_CACHE_LIMIT.validate("-1".into()).is_err());
         Ok(())
diff --git a/gix/tests/gix-init.rs b/gix/tests/gix-init.rs
@@ -38,8 +38,8 @@ mod with_overrides {
             .set("GIT_AUTHOR_EMAIL", "author email")
             .set("GIT_AUTHOR_DATE", default_date)
             .set("EMAIL", "user email")
-            .set("GITOXIDE_PACK_CACHE_MEMORY", "0")
-            .set("GITOXIDE_OBJECT_CACHE_MEMORY", "5m")
+            .set("GIX_PACK_CACHE_MEMORY", "0")
+            .set("GIX_OBJECT_CACHE_MEMORY", "5m")
             .set("GIT_SSL_CAINFO", "./env.pem")
             .set("GIT_SSL_VERSION", "tlsv1.3")
             .set("GIT_SSH_VARIANT", "ssh-variant-env")
diff --git a/src/plumbing/main.rs b/src/plumbing/main.rs
@@ -255,8 +255,8 @@ pub fn main() -> Result<()> {
                     let mut engine = core::corpus::Engine::open_or_create(
                         db,
                         core::corpus::engine::State {
-                            gitoxide_version: option_env!("GITOXIDE_VERSION")
-                                .ok_or_else(|| anyhow::anyhow!("GITOXIDE_VERSION must be set in build-script"))?
+                            gitoxide_version: option_env!("GIX_VERSION")
+                                .ok_or_else(|| anyhow::anyhow!("GIX_VERSION must be set in build-script"))?
                                 .into(),
                             progress,
                             trace_to_progress: trace,
diff --git a/src/plumbing/options/mod.rs b/src/plumbing/options/mod.rs
@@ -5,7 +5,7 @@ use gitoxide_core as core;
 use gix::bstr::BString;
 
 #[derive(Debug, clap::Parser)]
-#[clap(name = "gix", about = "The git underworld", version = option_env!("GITOXIDE_VERSION"))]
+#[clap(name = "gix", about = "The git underworld", version = option_env!("GIX_VERSION"))]
 #[clap(subcommand_required = true)]
 #[clap(arg_required_else_help = true)]
 pub struct Args {
diff --git a/src/porcelain/options.rs b/src/porcelain/options.rs
@@ -1,7 +1,7 @@
 use std::path::PathBuf;
 
 #[derive(Debug, clap::Parser)]
-#[clap(about = "The rusty git", version = option_env!("GITOXIDE_VERSION"))]
+#[clap(about = "The rusty git", version = option_env!("GIX_VERSION"))]
 #[clap(subcommand_required = true)]
 pub struct Args {
     /// Do not display verbose messages and progress information
diff --git a/tests/tools/src/lib.rs b/tests/tools/src/lib.rs
@@ -262,7 +262,7 @@ fn fixture_bytes_inner(path: impl AsRef<Path>, root: DirectoryRoot) -> Vec<u8> {
 /// In order to speed up CI and even local runs should the cache get purged, the result of each script run
 /// is automatically placed into a compressed _tar_ archive.
 /// If a script result doesn't exist, these will be checked first and extracted if present, which they are by default.
-/// This behaviour can be prohibited by setting the `GITOXIDE_TEST_IGNORE_ARCHIVES` to any value.
+/// This behaviour can be prohibited by setting the `GIX_TEST_IGNORE_ARCHIVES` to any value.
 ///
 /// To speed CI up, one can add these archives to the repository. It's absolutely recommended to use `gix-lfs` for that to
 /// not bloat the repository size.
@@ -631,11 +631,11 @@ fn extract_archive(
     let archive_buf: Vec<u8> = {
         let mut buf = Vec::new();
         let input_archive = std::fs::File::open(archive)?;
-        if std::env::var_os("GITOXIDE_TEST_IGNORE_ARCHIVES").is_some() {
+        if std::env::var_os("GIX_TEST_IGNORE_ARCHIVES").is_some() {
             return Err(std::io::Error::new(
                 std::io::ErrorKind::Other,
                 format!(
-                    "Ignoring archive at '{}' as GITOXIDE_TEST_IGNORE_ARCHIVES is set.",
+                    "Ignoring archive at '{}' as GIX_TEST_IGNORE_ARCHIVES is set.",
                     archive.display()
                 ),
             ));

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ fn main() {`
`8`	`8`	`.and_then(\|out\| parse_describe(&out.stdout))`
`9`	`9`	`.unwrap_or_else(\|\| env!("CARGO_PKG_VERSION").into());`
`10`	`10`
`11`		`- println!("cargo:rustc-env=GITOXIDE_VERSION={version}");`
	`11`	`+ println!("cargo:rustc-env=GIX_VERSION={version}");`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`fn parse_describe(input: &[u8]) -> Option<String> {`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ fn main() {`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`#[derive(Debug, clap::Parser)]`
`23`		`-#[clap(name = "log", about = "git log example", version = option_env!("GITOXIDE_VERSION"))]`
	`23`	`+#[clap(name = "log", about = "git log example", version = option_env!("GIX_VERSION"))]`
`24`	`24`	`struct Args {`
`25`	`25`	`/// Alternative git directory to use`
`26`	`26`	`#[clap(name = "dir", long = "git-dir")]`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ fn main() {`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`#[derive(Debug, clap::Parser)]`
`15`		`-#[clap(name = "ls-tree", about = "git ls-tree example", version = option_env!("GITOXIDE_VERSION"))]`
	`15`	`+#[clap(name = "ls-tree", about = "git ls-tree example", version = option_env!("GIX_VERSION"))]`
`16`	`16`	`#[clap(arg_required_else_help = true)]`
`17`	`17`	`struct Args {`
`18`	`18`	`/// Recurse into subtrees`