From: Josh Steadmon <steadmon@google.com>
To: git@vger.kernel.org
Cc: calvinwan@google.com, nasamuffin@google.com, emrass@google.com,
gitster@pobox.com, sandals@crustytoothpaste.net, ps@pks.im
Subject: [PATCH v7 0/4] Introduce libgit-rs, a Rust wrapper around libgit.a
Date: Mon, 27 Jan 2025 16:19:01 -0800 [thread overview]
Message-ID: <cover.1738023208.git.steadmon@google.com> (raw)
In-Reply-To: <cover.1723054623.git.steadmon@google.com>
This series provides two small Rust wrapper libraries around parts of
Git: "libgit-sys", which exposes a few functions from libgit.a, and
"libgit", which provides a more Rust-friendly interface to some of those
functions. In addition to included unit tests, at $DAYJOB we have tested
building JJ[1] with our library and used it to replace some of the
libgit2-rs uses.
[1] https://github.com/jj-vcs/jj
There is known NEEDSWORK, but I feel that they can be addressed in
follow-up changes, rather than in this series. If you feel otherwise,
please let me know:
* Investigate alternative methods of managing symbol visibility &
renaming.
* Figure out symbol versioning
Changes in V7:
* Moved the ConfigSet implementation in libgit-rs to a `config` module.
* Added doc comments for ConfigSet and its methods.
* Fix meson builds by adding new object files to `libgit_sources`
* Moved INCLUDE_LIBGIT_RS Makefile changes earlier in the series, so
that we can make it optional to compile some of the libgitpub sources.
Squashed V6 patch 5/5 into this series' patch 4/4.
* Don't publicly export FFI types in libgit-rs.
* Removed extraneous `-r` argument to $(RM) in the clean rules.
* Added TODO reminder in Cargo.toml about removing Cargo.lock once we
hit a certain minimum supported Rust version.
* Style cleanup in public_symbol_export.c
Changes in V6:
* Rebased onto current master, since V5 was several months old.
* Move libgit-sys out of libgit-rs; while this sort of nesting is common
in Rust crates with standalone repositories, it doesn't make as much
sense when they're contained in the larger Git project's repo.
* Standardize the naming of some of the Makefile targets to always
include a dash in the "-rs" or "-sys" suffixes.
* Clean up READMEs and crate descriptions in preparation for
uploading to crates.io.
Changes in V5:
* When building with INCLUDE_LIBGIT_RS defined, add
"-fvisibility=hidden" to CFLAGS. This allows us to manage symbol
visibility in libgitpub.a without causing `make all` to rebuild from
scratch due to changing CFLAGS.
* Avoid using c_int in the higher-level Rust API.
* Remove libgitpub.a and intermediate files with `make clean`.
Changes in V4:
* Drop V3 patch #3, which added wrappers around repository
initialization and config access. These are not well-libified, and
they are not necessary for JJ's proof-of-concept use case, so let's
avoid exporting them for now.
* Set a minimum supported Rust version of 1.63. Autodetect whether our
Rust version has c_int and c_char types; if not, define them
ourselves.
* When building libgitpub.a via build.rs, set DEVELOPER=1 to catch
additional errors at build time.
* In build.rs, use the make_cmd crate to portable select the correct
invocation of GNU Make.
* Follow naming standards for _alloc() and _free() functions.
* Use String instead of CString in higher-level API.
* Move libgit_configset_alloc() and libgit_configset_free() out of
upstream Git, to the libgitpub shim library.
* In libgitpub, initialize libgit_config_set structs in the _alloc()
function rather than with a separate _init() function.
* Remove unnecessary comments in libgit-sys showing where the wrapped
functions were originally defined.
* Fix clippy lint: don't reborrow configfile path references.
* Various typo fixes and `cargo fmt` fixes.
Changes in V3:
* Renamed cgit-rs to libgit-rs and cgit-sys to libgit-sys
* Makefile cleanup, particularly adding config.mak options that
developers can set to run Rust builds and tests by default (Patch 6)
* Provide testdata configs for unit tests
* ConfigSet API now uses &Path instead of &str -- more ergonomic for
Rust users to pass in and errors out if the path string isn't UTF-8
* Fixed unresolved dependency on libz in Cargo.toml
Calvin Wan (1):
libgit: add higher-level libgit crate
Josh Steadmon (3):
common-main: split init and exit code into new files
libgit-sys: introduce Rust wrapper for libgit.a
libgit-sys: also export some config_set functions
.gitignore | 2 +
Makefile | 45 +++++++++
common-exit.c | 26 ++++++
common-init.c | 63 +++++++++++++
common-init.h | 6 ++
common-main.c | 83 +----------------
contrib/libgit-rs/Cargo.lock | 77 ++++++++++++++++
contrib/libgit-rs/Cargo.toml | 17 ++++
contrib/libgit-rs/README.md | 13 +++
contrib/libgit-rs/build.rs | 4 +
contrib/libgit-rs/src/config.rs | 106 ++++++++++++++++++++++
contrib/libgit-rs/src/lib.rs | 1 +
contrib/libgit-rs/testdata/config1 | 2 +
contrib/libgit-rs/testdata/config2 | 2 +
contrib/libgit-rs/testdata/config3 | 2 +
contrib/libgit-sys/Cargo.lock | 69 ++++++++++++++
contrib/libgit-sys/Cargo.toml | 19 ++++
contrib/libgit-sys/README.md | 4 +
contrib/libgit-sys/build.rs | 35 +++++++
contrib/libgit-sys/public_symbol_export.c | 51 +++++++++++
contrib/libgit-sys/public_symbol_export.h | 18 ++++
contrib/libgit-sys/src/lib.rs | 79 ++++++++++++++++
meson.build | 2 +
t/Makefile | 15 +++
24 files changed, 660 insertions(+), 81 deletions(-)
create mode 100644 common-exit.c
create mode 100644 common-init.c
create mode 100644 common-init.h
create mode 100644 contrib/libgit-rs/Cargo.lock
create mode 100644 contrib/libgit-rs/Cargo.toml
create mode 100644 contrib/libgit-rs/README.md
create mode 100644 contrib/libgit-rs/build.rs
create mode 100644 contrib/libgit-rs/src/config.rs
create mode 100644 contrib/libgit-rs/src/lib.rs
create mode 100644 contrib/libgit-rs/testdata/config1
create mode 100644 contrib/libgit-rs/testdata/config2
create mode 100644 contrib/libgit-rs/testdata/config3
create mode 100644 contrib/libgit-sys/Cargo.lock
create mode 100644 contrib/libgit-sys/Cargo.toml
create mode 100644 contrib/libgit-sys/README.md
create mode 100644 contrib/libgit-sys/build.rs
create mode 100644 contrib/libgit-sys/public_symbol_export.c
create mode 100644 contrib/libgit-sys/public_symbol_export.h
create mode 100644 contrib/libgit-sys/src/lib.rs
Range-diff against v6:
1: ff6cd62397 ! 1: cd0cb9aa04 common-main: split init and exit code into new files
@@ common-main.c
-
- return code;
-}
+
+ ## meson.build ##
+@@ meson.build: libgit_sources = [
+ 'commit-graph.c',
+ 'commit-reach.c',
+ 'commit.c',
++ 'common-exit.c',
++ 'common-init.c',
+ 'compat/nonblock.c',
+ 'compat/obstack.c',
+ 'compat/terminal.c',
2: 5fc66cdb16 ! 2: f1502b8590 libgit-sys: introduce Rust wrapper for libgit.a
@@ .gitignore: Release/
+/contrib/libgit-sys/target
## Makefile ##
+@@ Makefile: include shared.mak
+ # Define LINK_FUZZ_PROGRAMS if you want `make all` to also build the fuzz test
+ # programs in oss-fuzz/.
+ #
++# Define INCLUDE_LIBGIT_RS if you want `make all` and `make test` to build and
++# test the Rust crate in contrib/libgit-sys.
++#
+ # === Optional library: libintl ===
+ #
+ # Define NO_GETTEXT if you don't want Git output to be translated.
@@ Makefile: CURL_CONFIG = curl-config
GCOV = gcov
STRIP = strip
@@ Makefile: CURL_CONFIG = curl-config
export TCL_PATH TCLTK_PATH
-@@ Makefile: OBJECTS += $(REFTABLE_OBJS) $(REFTABLE_TEST_OBJS)
- OBJECTS += $(UNIT_TEST_OBJS)
+@@ Makefile: ifdef FSMONITOR_OS_SETTINGS
+ COMPAT_OBJS += compat/fsmonitor/fsm-path-utils-$(FSMONITOR_OS_SETTINGS).o
+ endif
+
++ifdef INCLUDE_LIBGIT_RS
++ # Enable symbol hiding in contrib/libgit-sys/libgitpub.a without making
++ # us rebuild the whole tree every time we run a Rust build.
++ BASIC_CFLAGS += -fvisibility=hidden
++endif
++
+ ifeq ($(TCLTK_PATH),)
+ NO_TCLTK = NoThanks
+ endif
+@@ Makefile: OBJECTS += $(UNIT_TEST_OBJS)
OBJECTS += $(CLAR_TEST_OBJS)
OBJECTS += $(patsubst %,$(UNIT_TEST_DIR)/%.o,$(UNIT_TEST_PROGRAMS))
-+OBJECTS += contrib/libgit-sys/public_symbol_export.o
++ifdef INCLUDE_LIBGIT_RS
++ OBJECTS += contrib/libgit-sys/public_symbol_export.o
++endif
++
ifndef NO_CURL
OBJECTS += http.o http-walker.o remote-curl.o
+ endif
@@ Makefile: clean: profile-clean coverage-clean cocciclean
$(RM) $(htmldocs).tar.gz $(manpages).tar.gz
$(MAKE) -C Documentation/ clean
$(RM) Documentation/GIT-EXCLUDED-PROGRAMS
+ $(RM) -r contrib/libgit-sys/target
-+ $(RM) -r contrib/libgit-sys/partial_symbol_export.o
-+ $(RM) -r contrib/libgit-sys/hidden_symbol_export.o
-+ $(RM) -r contrib/libgit-sys/libgitpub.a
++ $(RM) contrib/libgit-sys/partial_symbol_export.o
++ $(RM) contrib/libgit-sys/hidden_symbol_export.o
++ $(RM) contrib/libgit-sys/libgitpub.a
ifndef NO_PERL
$(RM) -r perl/build/
endif
@@ Makefile: $(CLAR_TEST_PROG): $(UNIT_TEST_DIR)/clar.suite $(CLAR_TEST_OBJS) $(GIT
unit-tests: $(UNIT_TEST_PROGS) $(CLAR_TEST_PROG) t/helper/test-tool$X
$(MAKE) -C t/ unit-tests
+
++.PHONY: libgit-sys
++libgit-sys:
++ $(QUIET)(\
++ cd contrib/libgit-sys && \
++ cargo build \
++ )
++ifdef INCLUDE_LIBGIT_RS
++all:: libgit-sys
++endif
++
+contrib/libgit-sys/partial_symbol_export.o: contrib/libgit-sys/public_symbol_export.o libgit.a reftable/libreftable.a xdiff/lib.a
+ $(LD) -r $^ -o $@
+
@@ contrib/libgit-sys/Cargo.toml (new)
+edition = "2021"
+build = "build.rs"
+links = "gitpub"
-+rust-version = "1.63"
++rust-version = "1.63" # TODO: Once we hit 1.84 or newer, we may want to remove Cargo.lock from
++ # version control. See https://lore.kernel.org/git/Z47jgK-oMjFRSslr@tapette.crustytoothpaste.net/
+description = "Native bindings to a portion of libgit"
+
+[lib]
@@ contrib/libgit-sys/build.rs (new)
+ .env_remove("PROFILE")
+ .current_dir(git_root.clone())
+ .args([
-+ "CFLAGS=-fvisibility=hidden",
++ "INCLUDE_LIBGIT_RS=YesPlease",
+ "contrib/libgit-sys/libgitpub.a",
+ ])
+ .output()
@@ contrib/libgit-sys/build.rs (new)
## contrib/libgit-sys/public_symbol_export.c (new) ##
@@
-+// Shim to publicly export Git symbols. These must be renamed so that the
-+// original symbols can be hidden. Renaming these with a "libgit_" prefix also
-+// avoids conflicts with other libraries such as libgit2.
++/* Shim to publicly export Git symbols. These must be renamed so that the
++ * original symbols can be hidden. Renaming these with a "libgit_" prefix also
++ * avoids conflicts with other libraries such as libgit2.
++ */
+
+#include "git-compat-util.h"
+#include "contrib/libgit-sys/public_symbol_export.h"
@@ contrib/libgit-sys/src/lib.rs (new)
+ );
+ }
+}
+
+ ## t/Makefile ##
+@@ t/Makefile: perf:
+
+ .PHONY: pre-clean $(T) aggregate-results clean valgrind perf \
+ check-chainlint clean-chainlint test-chainlint $(UNIT_TESTS)
++
++.PHONY: libgit-sys-test
++libgit-sys-test:
++ $(QUIET)(\
++ cd ../contrib/libgit-sys && \
++ cargo test \
++ )
++ifdef INCLUDE_LIBGIT_RS
++all:: libgit-sys-test
++endif
3: 03f39b6c3a < -: ---------- libgit-sys: also export some config_set functions
5: 84706f0db7 ! 3: d67d3648d1 Makefile: add option to build and test libgit-rs and libgit-rs-sys
@@
## Metadata ##
-Author: Calvin Wan <calvinwan@google.com>
+Author: Josh Steadmon <steadmon@google.com>
## Commit message ##
- Makefile: add option to build and test libgit-rs and libgit-rs-sys
+ libgit-sys: also export some config_set functions
- Add libgitrs, libgitrs-sys, libgitrs-test, and libgitrs-sys-test targets
- to their respective Makefiles so they can be built and tested without
- having to run cargo build/test.
+ In preparation for implementing a higher-level Rust API for accessing
+ Git configs, export some of the upstream configset API via libgitpub and
+ libgit-sys. Since this will be exercised as part of the higher-level API
+ in the next commit, no tests have been added for libgit-sys.
- Add build variable, INCLUDE_LIBGIT_RS, that when set, automatically
- builds and tests libgit-rs and libgit-rs-sys when `make all` is run.
+ While we're at it, add git_configset_alloc() and git_configset_free()
+ functions in libgitpub so that callers can manage config_set structs on
+ the heap. This also allows non-C external consumers to treat config_sets
+ as opaque structs.
- Co-authored-by: Josh Steadmon <steadmon@google.com>
+ Co-authored-by: Calvin Wan <calvinwan@google.com>
Signed-off-by: Calvin Wan <calvinwan@google.com>
+ Signed-off-by: Josh Steadmon <steadmon@google.com>
- ## Makefile ##
-@@ Makefile: include shared.mak
- # Define LINK_FUZZ_PROGRAMS if you want `make all` to also build the fuzz test
- # programs in oss-fuzz/.
- #
-+# Define INCLUDE_LIBGIT_RS if you want `make all` and `make test` to build and
-+# test the Rust crates in contrib/libgit-rs/ and contrib/libgit-rs/libgit-sys/.
-+#
- # === Optional library: libintl ===
- #
- # Define NO_GETTEXT if you don't want Git output to be translated.
-@@ Makefile: ifdef FSMONITOR_OS_SETTINGS
- COMPAT_OBJS += compat/fsmonitor/fsm-path-utils-$(FSMONITOR_OS_SETTINGS).o
- endif
+ ## contrib/libgit-sys/public_symbol_export.c ##
+@@
+ */
-+ifdef INCLUDE_LIBGIT_RS
-+ # Enable symbol hiding in contrib/libgit-rs/libgit-sys/libgitpub.a
-+ # without making us rebuild the whole tree every time we run a Rust
-+ # build.
-+ BASIC_CFLAGS += -fvisibility=hidden
-+endif
-+
- ifeq ($(TCLTK_PATH),)
- NO_TCLTK = NoThanks
- endif
-@@ Makefile: build-unit-tests: $(UNIT_TEST_PROGS) $(CLAR_TEST_PROG)
- unit-tests: $(UNIT_TEST_PROGS) $(CLAR_TEST_PROG) t/helper/test-tool$X
- $(MAKE) -C t/ unit-tests
+ #include "git-compat-util.h"
++#include "config.h"
+ #include "contrib/libgit-sys/public_symbol_export.h"
+ #include "version.h"
-+.PHONY: libgit-sys
-+libgit-sys:
-+ $(QUIET)(\
-+ cd contrib/libgit-sys && \
-+ cargo build \
-+ )
-+.PHONY: libgit-rs
-+libgit-rs:
-+ $(QUIET)(\
-+ cd contrib/libgit-rs && \
-+ cargo build \
-+ )
-+ifdef INCLUDE_LIBGIT_RS
-+all:: libgit-rs
-+endif
-+
- contrib/libgit-sys/partial_symbol_export.o: contrib/libgit-sys/public_symbol_export.o libgit.a reftable/libreftable.a xdiff/lib.a
- $(LD) -r $^ -o $@
+ #pragma GCC visibility push(default)
++struct libgit_config_set *libgit_configset_alloc(void)
++{
++ struct config_set *cs = xmalloc(sizeof(struct config_set));
++ git_configset_init(cs);
++ return (struct libgit_config_set *) cs;
++}
++
++void libgit_configset_free(struct libgit_config_set *cs)
++{
++ git_configset_clear((struct config_set *) cs);
++ free((struct config_set *) cs);
++}
++
++int libgit_configset_add_file(struct libgit_config_set *cs, const char *filename)
++{
++ return git_configset_add_file((struct config_set *) cs, filename);
++}
++
++int libgit_configset_get_int(struct libgit_config_set *cs, const char *key, int *dest)
++{
++ return git_configset_get_int((struct config_set *) cs, key, dest);
++}
++
++int libgit_configset_get_string(struct libgit_config_set *cs, const char *key, char **dest)
++{
++ return git_configset_get_string((struct config_set *) cs, key, dest);
++}
++
+ const char *libgit_user_agent(void)
+ {
+ return git_user_agent();
- ## contrib/libgit-sys/build.rs ##
-@@ contrib/libgit-sys/build.rs: pub fn main() -> std::io::Result<()> {
- .env_remove("PROFILE")
- .current_dir(git_root.clone())
- .args([
-- "CFLAGS=-fvisibility=hidden",
-+ "INCLUDE_LIBGIT_RS=YesPlease",
- "contrib/libgit-sys/libgitpub.a",
- ])
- .output()
+ ## contrib/libgit-sys/public_symbol_export.h ##
+@@
+ #ifndef PUBLIC_SYMBOL_EXPORT_H
+ #define PUBLIC_SYMBOL_EXPORT_H
+
++struct libgit_config_set *libgit_configset_alloc(void);
++
++void libgit_configset_free(struct libgit_config_set *cs);
++
++int libgit_configset_add_file(struct libgit_config_set *cs, const char *filename);
++
++int libgit_configset_get_int(struct libgit_config_set *cs, const char *key, int *dest);
++
++int libgit_configset_get_string(struct libgit_config_set *cs, const char *key, char **dest);
++
+ const char *libgit_user_agent(void);
+
+ const char *libgit_user_agent_sanitized(void);
- ## t/Makefile ##
-@@ t/Makefile: perf:
+ ## contrib/libgit-sys/src/lib.rs ##
+@@
+ #[cfg(has_std__ffi__c_char)]
+-use std::ffi::c_char;
++use std::ffi::{c_char, c_int};
+
+ #[cfg(not(has_std__ffi__c_char))]
+ #[allow(non_camel_case_types)]
+ pub type c_char = i8;
+
++#[cfg(not(has_std__ffi__c_char))]
++#[allow(non_camel_case_types)]
++pub type c_int = i32;
++
+ extern crate libz_sys;
+
++#[allow(non_camel_case_types)]
++#[repr(C)]
++pub struct libgit_config_set {
++ _data: [u8; 0],
++ _marker: core::marker::PhantomData<(*mut u8, core::marker::PhantomPinned)>,
++}
++
+ extern "C" {
+ pub fn libgit_user_agent() -> *const c_char;
+ pub fn libgit_user_agent_sanitized() -> *const c_char;
++
++ pub fn libgit_configset_alloc() -> *mut libgit_config_set;
++ pub fn libgit_configset_free(cs: *mut libgit_config_set);
++
++ pub fn libgit_configset_add_file(cs: *mut libgit_config_set, filename: *const c_char) -> c_int;
++
++ pub fn libgit_configset_get_int(
++ cs: *mut libgit_config_set,
++ key: *const c_char,
++ int: *mut c_int,
++ ) -> c_int;
++
++ pub fn libgit_configset_get_string(
++ cs: *mut libgit_config_set,
++ key: *const c_char,
++ dest: *mut *mut c_char,
++ ) -> c_int;
++
+ }
- .PHONY: pre-clean $(T) aggregate-results clean valgrind perf \
- check-chainlint clean-chainlint test-chainlint $(UNIT_TESTS)
-+
-+.PHONY: libgit-sys-test
-+libgit-sys-test:
-+ $(QUIET)(\
-+ cd ../contrib/libgit-sys && \
-+ cargo test \
-+ )
-+.PHONY: libgit-rs-test
-+libgit-rs-test:
-+ $(QUIET)(\
-+ cd ../contrib/libgit-rs && \
-+ cargo test \
-+ )
-+ifdef INCLUDE_LIBGIT_RS
-+all:: libgit-sys-test libgit-rs-test
-+endif
+ #[cfg(test)]
4: 65166ea0c0 ! 4: 88425bb0b1 libgit: add higher-level libgit crate
@@ .gitignore: Release/
/contrib/libgit-sys/target
## Makefile ##
+@@ Makefile: include shared.mak
+ # programs in oss-fuzz/.
+ #
+ # Define INCLUDE_LIBGIT_RS if you want `make all` and `make test` to build and
+-# test the Rust crate in contrib/libgit-sys.
++# test the Rust crates in contrib/libgit-sys and contrib/libgit-rs.
+ #
+ # === Optional library: libintl ===
+ #
@@ Makefile: clean: profile-clean coverage-clean cocciclean
$(RM) $(htmldocs).tar.gz $(manpages).tar.gz
$(MAKE) -C Documentation/ clean
$(RM) Documentation/GIT-EXCLUDED-PROGRAMS
- $(RM) -r contrib/libgit-sys/target
-+ $(RM) -r contrib/libgit-rs/target contrib/libgit-sys/target
- $(RM) -r contrib/libgit-sys/partial_symbol_export.o
- $(RM) -r contrib/libgit-sys/hidden_symbol_export.o
- $(RM) -r contrib/libgit-sys/libgitpub.a
++ $(RM) -r contrib/libgit-sys/target contrib/libgit-rs/target
+ $(RM) contrib/libgit-sys/partial_symbol_export.o
+ $(RM) contrib/libgit-sys/hidden_symbol_export.o
+ $(RM) contrib/libgit-sys/libgitpub.a
+@@ Makefile: build-unit-tests: $(UNIT_TEST_PROGS) $(CLAR_TEST_PROG)
+ unit-tests: $(UNIT_TEST_PROGS) $(CLAR_TEST_PROG) t/helper/test-tool$X
+ $(MAKE) -C t/ unit-tests
+
+-.PHONY: libgit-sys
++.PHONY: libgit-sys libgit-rs
+ libgit-sys:
+ $(QUIET)(\
+ cd contrib/libgit-sys && \
+ cargo build \
+ )
++libgit-rs:
++ $(QUIET)(\
++ cd contrib/libgit-rs && \
++ cargo build \
++ )
+ ifdef INCLUDE_LIBGIT_RS
+-all:: libgit-sys
++all:: libgit-sys libgit-rs
+ endif
+
+ contrib/libgit-sys/partial_symbol_export.o: contrib/libgit-sys/public_symbol_export.o libgit.a reftable/libreftable.a xdiff/lib.a
## contrib/libgit-rs/Cargo.lock (new) ##
@@
@@ contrib/libgit-rs/Cargo.toml (new)
+version = "0.1.0"
+edition = "2021"
+build = "build.rs"
-+rust-version = "1.63"
++rust-version = "1.63" # TODO: Once we hit 1.84 or newer, we may want to remove Cargo.lock from
++ # version control. See https://lore.kernel.org/git/Z47jgK-oMjFRSslr@tapette.crustytoothpaste.net/
++
+
+[lib]
+path = "src/lib.rs"
@@ contrib/libgit-rs/build.rs (new)
+ ac.emit_has_path("std::ffi::c_char");
+}
- ## contrib/libgit-rs/src/lib.rs (new) ##
+ ## contrib/libgit-rs/src/config.rs (new) ##
@@
+use std::ffi::{c_void, CStr, CString};
+use std::path::Path;
@@ contrib/libgit-rs/src/lib.rs (new)
+
+#[cfg(not(has_std__ffi__c_char))]
+#[allow(non_camel_case_types)]
-+pub type c_char = i8;
++type c_char = i8;
+
+#[cfg(not(has_std__ffi__c_char))]
+#[allow(non_camel_case_types)]
-+pub type c_int = i32;
++type c_int = i32;
+
+use libgit_sys::*;
+
++/// A ConfigSet is an in-memory cache for config-like files such as `.gitmodules` or `.gitconfig`.
++/// It does not support all config directives; notably, it will not process `include` or
++/// `includeIf` directives (but it will store them so that callers can choose whether and how to
++/// handle them).
+pub struct ConfigSet(*mut libgit_config_set);
+impl ConfigSet {
++ /// Allocate a new ConfigSet
+ pub fn new() -> Self {
+ unsafe { ConfigSet(libgit_configset_alloc()) }
+ }
+
++ /// Load the given files into the ConfigSet; conflicting directives in later files will
++ /// override those given in earlier files.
+ pub fn add_files(&mut self, files: &[&Path]) {
+ for file in files {
+ let pstr = file.to_str().expect("Invalid UTF-8");
@@ contrib/libgit-rs/src/lib.rs (new)
+ }
+ }
+
++ /// Load the value for the given key and attempt to parse it as an i32. Dies with a fatal error
++ /// if the value cannot be parsed. Returns None if the key is not present.
+ pub fn get_int(&mut self, key: &str) -> Option<i32> {
+ let key = CString::new(key).expect("Couldn't convert to CString");
+ let mut val: c_int = 0;
@@ contrib/libgit-rs/src/lib.rs (new)
+ Some(val.into())
+ }
+
++ /// Clones the value for the given key. Dies with a fatal error if the value cannot be
++ /// converted to a String. Returns None if the key is not present.
+ pub fn get_string(&mut self, key: &str) -> Option<String> {
+ let key = CString::new(key).expect("Couldn't convert key to CString");
+ let mut val: *mut c_char = std::ptr::null_mut();
@@ contrib/libgit-rs/src/lib.rs (new)
+ }
+}
+ ## contrib/libgit-rs/src/lib.rs (new) ##
+@@
++pub mod config;
+
## contrib/libgit-rs/testdata/config1 (new) ##
@@
+[trace2]
@@ contrib/libgit-sys/src/lib.rs: pub struct libgit_config_set {
pub fn libgit_user_agent() -> *const c_char;
pub fn libgit_user_agent_sanitized() -> *const c_char;
+
+ ## t/Makefile ##
+@@ t/Makefile: perf:
+ .PHONY: pre-clean $(T) aggregate-results clean valgrind perf \
+ check-chainlint clean-chainlint test-chainlint $(UNIT_TESTS)
+
+-.PHONY: libgit-sys-test
++.PHONY: libgit-sys-test libgit-rs-test
+ libgit-sys-test:
+ $(QUIET)(\
+ cd ../contrib/libgit-sys && \
+ cargo test \
+ )
++libgit-rs-test:
++ $(QUIET)(\
++ cd ../contrib/libgit-rs && \
++ cargo test \
++ )
+ ifdef INCLUDE_LIBGIT_RS
+-all:: libgit-sys-test
++all:: libgit-sys-test libgit-rs-test
+ endif
base-commit: 757161efcca150a9a96b312d9e780a071e601a03
--
2.48.1.262.g85cc9f2d1e-goog
next prev parent reply other threads:[~2025-01-28 0:19 UTC|newest]
Thread overview: 217+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-07 18:21 [RFC PATCH 0/6] [RFC] Introduce cgit-rs, a Rust wrapper around libgit.a Josh Steadmon
2024-08-07 18:21 ` [RFC PATCH 1/6] common-main: split common_exit() into a new file Josh Steadmon
2024-08-07 21:21 ` Junio C Hamano
2024-08-07 22:54 ` Josh Steadmon
2024-08-07 18:21 ` [RFC PATCH 2/6] repository: add initialize_repo wrapper without pointer Josh Steadmon
2024-08-07 22:52 ` Mike Hommey
2024-08-07 23:23 ` Josh Steadmon
2024-08-07 23:29 ` Mike Hommey
2024-08-08 17:50 ` Josh Steadmon
2024-08-07 18:21 ` [RFC PATCH 3/6] contrib/cgit-rs: introduce Rust wrapper for libgit.a Josh Steadmon
2024-08-07 21:21 ` brian m. carlson
2024-08-07 21:40 ` rsbecker
2024-08-07 23:07 ` Josh Steadmon
2024-08-07 23:51 ` rsbecker
2024-08-08 17:13 ` Josh Steadmon
2024-08-08 18:43 ` rsbecker
2024-08-08 19:57 ` Junio C Hamano
2024-08-08 20:14 ` rsbecker
2024-08-12 2:00 ` rsbecker
2024-08-07 23:05 ` Josh Steadmon
2024-08-07 23:55 ` brian m. carlson
2024-08-08 2:21 ` Junio C Hamano
2024-08-08 17:15 ` Josh Steadmon
2024-08-08 18:22 ` Josh Steadmon
2024-08-08 20:18 ` Kyle Lippincott
2024-08-08 20:43 ` Josh Steadmon
2024-08-07 22:47 ` Mike Hommey
2024-08-07 23:29 ` Josh Steadmon
2024-08-08 0:17 ` Mike Hommey
2024-08-08 17:23 ` Josh Steadmon
2024-08-07 18:21 ` [RFC PATCH 4/6] contrib/cgit-rs: add repo initialization and config access Josh Steadmon
2024-08-07 21:26 ` brian m. carlson
2024-08-07 23:14 ` Josh Steadmon
2024-08-08 0:04 ` brian m. carlson
2024-08-07 18:21 ` [RFC PATCH 5/6] config: add git_configset_alloc Josh Steadmon
2024-08-07 18:21 ` [RFC PATCH 6/6] contrib/cgit-rs: add a subset of configset wrappers Josh Steadmon
2024-08-07 21:40 ` brian m. carlson
2024-08-07 21:53 ` Junio C Hamano
2024-08-08 21:44 ` Josh Steadmon
2024-09-04 17:30 ` Calvin Wan
2024-09-04 17:49 ` brian m. carlson
2024-09-06 19:37 ` Calvin Wan
2024-09-07 14:53 ` brian m. carlson
2024-09-04 18:33 ` Junio C Hamano
2024-09-04 19:03 ` brian m. carlson
2024-09-04 21:08 ` Junio C Hamano
2024-09-04 21:29 ` Josh Steadmon
2024-08-07 22:03 ` [RFC PATCH 0/6] [RFC] Introduce cgit-rs, a Rust wrapper around libgit.a brian m. carlson
2024-08-07 23:19 ` Josh Steadmon
2024-08-08 1:33 ` brian m. carlson
2024-08-09 22:16 ` Josh Steadmon
2024-08-08 11:51 ` Jason A. Donenfeld
2024-08-08 13:59 ` Dragan Simic
2024-08-08 15:38 ` rsbecker
2024-08-08 15:47 ` Dragan Simic
2024-08-08 17:20 ` Junio C Hamano
2024-08-09 19:22 ` Junio C Hamano
2024-08-09 19:29 ` Junio C Hamano
2024-08-09 22:27 ` Josh Steadmon
2024-08-09 20:54 ` Junio C Hamano
2024-08-09 22:26 ` Junio C Hamano
2024-08-09 22:28 ` Josh Steadmon
2024-08-09 22:32 ` Junio C Hamano
2024-08-09 22:41 ` [PATCH v2 0/5] " Josh Steadmon
2024-08-09 22:41 ` [PATCH v2 1/5] common-main: split init and exit code into new files Josh Steadmon
2024-08-09 22:41 ` [PATCH v2 2/5] cgit-sys: introduce Rust wrapper for libgit.a Josh Steadmon
2024-08-09 22:41 ` [PATCH v2 3/5] cgit-sys: add repo initialization and config access Josh Steadmon
2024-08-09 22:41 ` [PATCH v2 4/5] config: add git_configset_alloc() and git_configset_clear_and_free() Josh Steadmon
2024-08-12 9:10 ` Phillip Wood
2024-08-12 21:39 ` Josh Steadmon
2024-08-12 21:55 ` Kyle Lippincott
2024-08-13 9:51 ` phillip.wood123
2024-08-13 15:16 ` Junio C Hamano
2024-08-13 9:48 ` phillip.wood123
2024-10-02 22:12 ` Josh Steadmon
2024-08-16 11:24 ` Patrick Steinhardt
2024-10-02 22:17 ` Josh Steadmon
2024-08-09 22:41 ` [PATCH v2 5/5] cgit: add higher-level cgit crate Josh Steadmon
2024-08-12 9:26 ` Phillip Wood
2024-08-21 18:46 ` Calvin Wan
2024-08-21 19:23 ` Kyle Lippincott
2024-08-22 13:24 ` Phillip Wood
2024-08-22 9:12 ` Phillip Wood
2024-10-02 22:31 ` Josh Steadmon
2024-08-09 23:36 ` [PATCH v2 0/5] Introduce cgit-rs, a Rust wrapper around libgit.a Junio C Hamano
2024-08-10 13:15 ` Jason A. Donenfeld
2024-08-11 17:26 ` Dragan Simic
2024-08-11 23:03 ` Eric Sunshine
2024-08-11 23:23 ` Dragan Simic
2024-08-11 23:33 ` Eric Sunshine
2024-08-11 23:37 ` Dragan Simic
2024-08-12 8:15 ` Junio C Hamano
2024-08-12 9:03 ` Eric Sunshine
2024-08-12 18:11 ` Junio C Hamano
2024-08-12 21:32 ` Josh Steadmon
2024-08-16 11:39 ` Patrick Steinhardt
2024-08-16 21:38 ` brian m. carlson
2024-08-17 0:15 ` Eric Sunshine
2024-08-18 1:37 ` Junio C Hamano
2024-08-12 22:14 ` brian m. carlson
2024-08-12 18:08 ` Dragan Simic
2024-08-12 21:24 ` Josh Steadmon
2024-08-12 21:37 ` Junio C Hamano
2024-08-12 22:02 ` Junio C Hamano
2024-09-06 22:18 ` [PATCH v3 0/6] Introduce libgit-rs, " Calvin Wan
2024-09-06 22:21 ` [PATCH v3 1/6] common-main: split init and exit code into new files Calvin Wan
2024-09-06 22:21 ` [PATCH v3 2/6] libgit-sys: introduce Rust wrapper for libgit.a Calvin Wan
2024-09-06 22:39 ` Eric Sunshine
2024-09-06 23:04 ` Mike Hommey
2024-09-08 21:32 ` Junio C Hamano
2024-09-18 21:14 ` Josh Steadmon
2024-09-10 19:04 ` Calvin Wan
2024-09-18 21:14 ` Josh Steadmon
2024-09-06 22:21 ` [PATCH v3 3/6] libgit-sys: add repo initialization and config access Calvin Wan
2024-09-06 22:53 ` Eric Sunshine
2024-09-18 21:33 ` Josh Steadmon
2024-09-06 23:45 ` Junio C Hamano
2024-09-18 21:33 ` Josh Steadmon
2024-09-10 6:42 ` Patrick Steinhardt
2024-10-07 21:21 ` Josh Steadmon
2024-10-08 20:59 ` Josh Steadmon
2024-09-06 22:21 ` [PATCH v3 4/6] config: add git_configset_alloc() and git_configset_clear_and_free() Calvin Wan
2024-09-06 23:24 ` Eric Sunshine
2024-09-10 6:41 ` Patrick Steinhardt
2024-09-10 8:50 ` Phillip Wood
2024-09-10 14:44 ` Junio C Hamano
2024-09-10 19:26 ` Calvin Wan
2024-10-02 22:45 ` Josh Steadmon
2024-09-06 22:21 ` [PATCH v3 5/6] libgit: add higher-level libgit crate Calvin Wan
2024-09-07 0:09 ` Junio C Hamano
2024-09-09 20:47 ` Junio C Hamano
2024-09-10 19:04 ` Calvin Wan
2024-09-10 19:14 ` Junio C Hamano
2024-09-17 22:29 ` Josh Steadmon
2024-09-18 16:34 ` Junio C Hamano
2024-10-07 23:31 ` Josh Steadmon
2024-09-17 21:37 ` Josh Steadmon
2024-09-06 22:21 ` [PATCH v3 6/6] Makefile: add option to build and test libgit-rs and libgit-rs-sys Calvin Wan
2024-09-07 15:15 ` Sean Allred
2024-09-08 21:33 ` Junio C Hamano
2024-09-10 19:12 ` Calvin Wan
2024-09-13 19:01 ` brian m. carlson
2024-10-07 21:23 ` Josh Steadmon
2024-10-02 22:49 ` Josh Steadmon
2024-10-08 23:19 ` [PATCH v4 0/5] Introduce libgit-rs, a Rust wrapper around libgit.a Josh Steadmon
2024-10-08 23:19 ` [PATCH v4 1/5] common-main: split init and exit code into new files Josh Steadmon
2024-10-08 23:19 ` [PATCH v4 2/5] libgit-sys: introduce Rust wrapper for libgit.a Josh Steadmon
2024-10-08 23:19 ` [PATCH v4 3/5] libgit-sys: also export some config_set functions Josh Steadmon
2024-10-08 23:19 ` [PATCH v4 4/5] libgit: add higher-level libgit crate Josh Steadmon
2024-10-09 6:18 ` Eric Sunshine
2024-10-09 21:21 ` Josh Steadmon
2024-10-09 22:25 ` Josh Steadmon
2024-10-08 23:19 ` [PATCH v4 5/5] Makefile: add option to build and test libgit-rs and libgit-rs-sys Josh Steadmon
2024-10-08 23:45 ` Junio C Hamano
2024-10-09 0:12 ` rsbecker
2024-10-14 20:19 ` Josh Steadmon
2024-10-09 0:01 ` Junio C Hamano
2024-10-09 21:53 ` Josh Steadmon
2024-10-10 0:52 ` Junio C Hamano
2024-10-14 20:13 ` Josh Steadmon
2024-10-09 0:10 ` Junio C Hamano
2024-10-09 22:24 ` Josh Steadmon
2024-10-15 22:50 ` [PATCH v5 0/5] Introduce libgit-rs, a Rust wrapper around libgit.a Josh Steadmon
2024-10-15 22:50 ` [PATCH v5 1/5] common-main: split init and exit code into new files Josh Steadmon
2024-10-15 22:50 ` [PATCH v5 2/5] libgit-sys: introduce Rust wrapper for libgit.a Josh Steadmon
2024-10-15 22:50 ` [PATCH v5 3/5] libgit-sys: also export some config_set functions Josh Steadmon
2024-10-15 22:50 ` [PATCH v5 4/5] libgit: add higher-level libgit crate Josh Steadmon
2024-10-15 22:50 ` [PATCH v5 5/5] Makefile: add option to build and test libgit-rs and libgit-rs-sys Josh Steadmon
2024-12-03 5:36 ` [PATCH v5 0/5] Introduce libgit-rs, a Rust wrapper around libgit.a Junio C Hamano
2025-01-15 20:05 ` [PATCH v6 " Josh Steadmon
2025-01-15 20:05 ` [PATCH v6 1/5] common-main: split init and exit code into new files Josh Steadmon
2025-01-15 22:40 ` Junio C Hamano
2025-01-16 2:46 ` Junio C Hamano
2025-01-16 21:02 ` Junio C Hamano
2025-01-17 9:44 ` Patrick Steinhardt
2025-01-21 23:21 ` Josh Steadmon
2025-01-15 20:05 ` [PATCH v6 2/5] libgit-sys: introduce Rust wrapper for libgit.a Josh Steadmon
2025-01-15 23:13 ` Junio C Hamano
2025-01-22 0:03 ` Josh Steadmon
2025-01-27 23:18 ` Josh Steadmon
2025-01-15 20:05 ` [PATCH v6 3/5] libgit-sys: also export some config_set functions Josh Steadmon
2025-01-15 20:05 ` [PATCH v6 4/5] libgit: add higher-level libgit crate Josh Steadmon
2025-01-21 0:00 ` brian m. carlson
2025-01-22 0:01 ` Josh Steadmon
2025-01-15 20:05 ` [PATCH v6 5/5] Makefile: add option to build and test libgit-rs and libgit-rs-sys Josh Steadmon
2025-01-15 22:31 ` [PATCH v6 0/5] Introduce libgit-rs, a Rust wrapper around libgit.a Junio C Hamano
2025-01-21 0:05 ` brian m. carlson
2025-01-21 1:17 ` Junio C Hamano
2025-01-28 0:19 ` Josh Steadmon [this message]
2025-01-28 0:19 ` [PATCH v7 1/4] common-main: split init and exit code into new files Josh Steadmon
2025-01-28 0:19 ` [PATCH v7 2/4] libgit-sys: introduce Rust wrapper for libgit.a Josh Steadmon
2025-01-28 15:08 ` Phillip Wood
2025-01-28 20:26 ` Josh Steadmon
2025-01-28 20:44 ` Junio C Hamano
2025-01-28 0:19 ` [PATCH v7 3/4] libgit-sys: also export some config_set functions Josh Steadmon
2025-01-28 15:08 ` Phillip Wood
2025-01-28 20:47 ` Josh Steadmon
2025-01-28 0:19 ` [PATCH v7 4/4] libgit: add higher-level libgit crate Josh Steadmon
2025-01-28 4:56 ` Junio C Hamano
2025-01-28 20:50 ` Josh Steadmon
2025-01-28 21:17 ` Junio C Hamano
2025-01-28 22:01 ` [PATCH v8 0/4] Introduce libgit-rs, a Rust wrapper around libgit.a Josh Steadmon
2025-01-28 22:01 ` [PATCH v8 1/4] common-main: split init and exit code into new files Josh Steadmon
2025-01-28 22:01 ` [PATCH v8 2/4] libgit-sys: introduce Rust wrapper for libgit.a Josh Steadmon
2025-01-28 22:43 ` Junio C Hamano
2025-01-29 21:40 ` Josh Steadmon
2025-01-28 22:01 ` [PATCH v8 3/4] libgit-sys: also export some config_set functions Josh Steadmon
2025-01-28 22:01 ` [PATCH v8 4/4] libgit: add higher-level libgit crate Josh Steadmon
2025-01-29 15:24 ` [PATCH v8 0/4] Introduce libgit-rs, a Rust wrapper around libgit.a Phillip Wood
2025-01-29 21:42 ` Josh Steadmon
2025-01-29 21:50 ` [PATCH v9 " Josh Steadmon
2025-01-29 21:50 ` [PATCH v9 1/4] common-main: split init and exit code into new files Josh Steadmon
2025-01-29 21:50 ` [PATCH v9 2/4] libgit-sys: introduce Rust wrapper for libgit.a Josh Steadmon
2025-01-29 21:50 ` [PATCH v9 3/4] libgit-sys: also export some config_set functions Josh Steadmon
2025-01-29 21:50 ` [PATCH v9 4/4] libgit: add higher-level libgit crate Josh Steadmon
2025-01-30 10:49 ` [PATCH v9 0/4] Introduce libgit-rs, a Rust wrapper around libgit.a phillip.wood123
2025-01-30 19:32 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=cover.1738023208.git.steadmon@google.com \
--to=steadmon@google.com \
--cc=calvinwan@google.com \
--cc=emrass@google.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=nasamuffin@google.com \
--cc=ps@pks.im \
--cc=sandals@crustytoothpaste.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).