Elgato_dark/gitui
1
0
Fork 0
mirror of https://github.com/gitui-org/gitui synced 2026-05-23 00:48:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

little more documentation

Browse source
This commit is contained in:
Stephan Dilly 2020-07-08 00:00:17 +02:00
parent 083e06c57c
commit 535b0cd103
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
asyncgit/README.md
View file

@ -1,6 +1,12 @@
# asyncgit
*allow using git2 in a asynchronous context*
*allow using git2 in an asynchronous context*
This crate is designed as part of the [gitui](http://gitui.org) project.
`asyncgit` provides the primary interface to interact with *git* repositories. It is split into the main module and a `sync` part. The latter provides convenience wrapper for typical usage patterns against git repositories.
The primary goal however is to allow putting certain (potentially) long running [git2](https://github.com/rust-lang/git2-rs) calls onto a thread pool.[crossbeam-channel](https://github.com/crossbeam-rs/crossbeam) is then used to wait for a notification confirming the result.
In `gitui` this allows the main-thread and therefore the *ui* to stay responsive.
This crate is part of the [gitui](http://gitui.org) project.
It is used put long running [git2](https://github.com/rust-lang/git2-rs) calls onto a thread pool and use [crossbeam-channel](https://github.com/crossbeam-rs/crossbeam) to wait for a message to confirm the call finished.