mirror of
https://git.proxmox.com/git/libgit2
synced 2025-05-09 13:04:42 +00:00
Merge pull request #3978 from pks-t/pks/doc-improvements
Small documentation improvements
This commit is contained in:
commit
a051ee31f2
@ -5,7 +5,7 @@ So, you want to start helping out with `libgit2`? That's fantastic! We
|
||||
welcome contributions and we promise we'll try to be nice.
|
||||
|
||||
This is a list of libgit2 related projects that new contributors can take
|
||||
on. It includes a number of good starter projects and well as some larger
|
||||
on. It includes a number of good starter projects as well as some larger
|
||||
ideas that no one is actively working on.
|
||||
|
||||
## Before You Start
|
||||
@ -70,11 +70,11 @@ some incremental steps listed towards the larger goal. Those steps
|
||||
might make good smaller projects by themselves.
|
||||
|
||||
* Port part of the Git test suite to run against the command line emulation
|
||||
in examples/
|
||||
* Pick a Git command that is emulated in our examples/ area
|
||||
in `examples/`
|
||||
* Pick a Git command that is emulated in our `examples/` area
|
||||
* Extract the Git tests that exercise that command
|
||||
* Convert the tests to call our emulation
|
||||
* These tests could go in examples/tests/...
|
||||
* These tests could go in `examples/tests/`...
|
||||
* Add hooks API to enumerate and manage hooks (not run them at this point)
|
||||
* Enumeration of available hooks
|
||||
* Lookup API to see which hooks have a script and get the script
|
||||
|
@ -88,7 +88,7 @@ of libssh2 as described above, `git_openssl_set_locking()` is a no-op.
|
||||
|
||||
If your programming language offers a package/bindings for OpenSSL,
|
||||
you should very strongly prefer to use that in order to set up
|
||||
locking, as they provide a level of coördination which is impossible
|
||||
locking, as they provide a level of coordination which is impossible
|
||||
when using this function.
|
||||
|
||||
See the
|
||||
@ -102,7 +102,7 @@ if there are alternatives provided by the system.
|
||||
libssh2 may be linked against OpenSSL or libgcrypt. If it uses OpenSSL,
|
||||
see the above paragraphs. If it uses libgcrypt, then you need to
|
||||
set up its locking before using it multi-threaded. libgit2 has no
|
||||
direct connection to libgcrypt and thus has not convenience functions for
|
||||
direct connection to libgcrypt and thus has no convenience functions for
|
||||
it (but libgcrypt has macros). Read libgcrypt's
|
||||
[threading documentation for more information](http://www.gnupg.org/documentation/manuals/gcrypt/Multi_002dThreading.html)
|
||||
|
||||
|
@ -148,7 +148,7 @@ int git_openssl_set_locking(void)
|
||||
git__on_shutdown(shutdown_ssl_locking);
|
||||
return 0;
|
||||
#else
|
||||
giterr_set(GITERR_THREAD, "libgit2 as not built with threads");
|
||||
giterr_set(GITERR_THREAD, "libgit2 was not built with threads");
|
||||
return -1;
|
||||
#endif
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user