diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-30 18:31:36 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-30 18:31:36 +0000 |
commit | e02c5b5930c2c9ba3e5423fe12e2ef0155017297 (patch) | |
tree | fd60ebbbb5299e16e5fca8c773ddb74f764760db /extra/git2/README.md | |
parent | Adding debian version 1.73.0+dfsg1-1. (diff) | |
download | rustc-e02c5b5930c2c9ba3e5423fe12e2ef0155017297.tar.xz rustc-e02c5b5930c2c9ba3e5423fe12e2ef0155017297.zip |
Merging upstream version 1.74.1+dfsg1.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'extra/git2/README.md')
-rw-r--r-- | extra/git2/README.md | 71 |
1 files changed, 0 insertions, 71 deletions
diff --git a/extra/git2/README.md b/extra/git2/README.md deleted file mode 100644 index ba75127ac..000000000 --- a/extra/git2/README.md +++ /dev/null @@ -1,71 +0,0 @@ -# git2-rs - -[Documentation](https://docs.rs/git2) - -libgit2 bindings for Rust. - -```toml -[dependencies] -git2 = "0.18.1" -``` - -## Rust version requirements - -git2-rs works with stable Rust, and typically works with the most recent prior -stable release as well. - -## Version of libgit2 - -Currently this library requires libgit2 1.7.1 (or newer patch versions). The -source for libgit2 is included in the libgit2-sys crate so there's no need to -pre-install the libgit2 library, the libgit2-sys crate will figure that and/or -build that for you. - -You can enable the Cargo feature `vendored-libgit2` to always compile and -statically link to a copy of libgit2. Sometimes the libgit2 on the system is -required to be found and used even when `vendored-libgit2` is activated. In -this case, you shall set the environment variable `LIBGIT2_NO_VENDOR=1`. - -## Building git2-rs - -```sh -$ git clone https://github.com/rust-lang/git2-rs -$ cd git2-rs -$ cargo build -``` - -### Automating Testing - -Running tests and handling all of the associated edge cases on every commit -proves tedious very quickly. To automate tests and handle proper stashing and -unstashing of unstaged changes and thus avoid nasty surprises, use the -pre-commit hook found [here][pre-commit-hook] and place it into the -`.git/hooks/` with the name `pre-commit`. You may need to add execution -permissions with `chmod +x`. - -To skip tests on a simple commit or doc-fixes, use `git commit --no-verify`. - -## Building on macOS 10.10+ - -If the `ssh` feature is enabled (and it is by default) then this library depends -on libssh2 which depends on OpenSSL. To get OpenSSL working follow the -[`openssl` crate's instructions](https://github.com/sfackler/rust-openssl/blob/master/openssl/src/lib.rs#L31). - -# License - -This project is licensed under either of - - * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or - https://www.apache.org/licenses/LICENSE-2.0) - * MIT license ([LICENSE-MIT](LICENSE-MIT) or - https://opensource.org/licenses/MIT) - -at your option. - -### Contribution - -Unless you explicitly state otherwise, any contribution intentionally submitted -for inclusion in git2-rs by you, as defined in the Apache-2.0 license, shall be -dual licensed as above, without any additional terms or conditions. - -[pre-commit-hook]: https://gist.github.com/glfmn/0c5e9e2b41b48007ed3497d11e3dbbfa |