summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* cmake: standardize USE_THREADS and USE_NSECEdward Thomson2021-11-111-1/+1
| | | | | | | | Threading can now be disabled with `USE_THREADS=OFF` instead of `THREADSAFE=OFF` to better support the other cmake semantics. Nanosecond support is the default _if_ we can detect it. This should be our default always - like threads - and people can opt out explicitly.
* Document that `git_odb` is thread-safeJosh Triplett2021-11-111-0/+3
| | | | | | | Commit 4ae41f9c639d246d34dac89c3f1d9451c9cfa8d3 made `git_odb` race-free, and added internal locking. Update `docs/threading.md` accordingly, so that APIs built atop libgit2 (e.g. language bindings) can count on this.
* libgit2_clar is now libgit2_testsMartin Kühl2021-10-281-4/+4
| | | | | | in #6083 the test runner was renamed to libgit2_tests, but not all references to the old name were updated. this change changes all of them to use the new name.
* cmake: BUILD_CLAR is now BUILD_TESTSethomson/clar_no_moreEdward Thomson2021-10-171-1/+1
| | | | | Nobody knows what CLAR is. The test building option should be `BUILD_TESTS`.
* docs: document `git_buf`Edward Thomson2021-10-171-0/+63
| | | | | | | | | | | | | | | We have been inconsistent about the way that we handle `git_buf`s provided by users. _Usually_ we require that it has been properly initialized with `GIT_BUF_INIT`, but _sometimes_ we simply overwrite the data in it regardless. And even more rarely, we will grow a user-provided buffer and concatenate data onto it (see `git_diff_format_email`). Document the path forward for `git_buf`, which is that we always require that the buffer is intitialized with `GIT_BUF_INIT`. `git_diff_format_email` will be kept backward compatible but users are encouraged to switch to the new `git_email` APIs.
* v1.3: very very last-minute changelog updatesv1.3.0Edward Thomson2021-09-271-0/+2
|
* v1.3: changelog updates for last-minute changesEdward Thomson2021-09-271-1/+8
|
* changelog: separate releases with a horizontal ruleEdward Thomson2021-09-221-0/+18
|
* changelog: fix typoEdward Thomson2021-09-221-1/+1
|
* v1.3: changelogEdward Thomson2021-09-221-0/+46
|
* v1.2: changelogEdward Thomson2021-08-311-16/+170
|
* Merge branch 'main' into http-use-eauthEdward Thomson2021-08-296-32/+916
|\
| * Merge pull request #5916 from boretrk/docEdward Thomson2021-07-021-1/+1
| |\ | | | | | | Update from regex to pcre licensing information in docs/contributing.md
| | * Update from regex to pcre licensing informationPeter Pettersson2021-06-171-1/+1
| | |
| * | Update docs/release.mdEdward Thomson2021-06-251-1/+1
| | | | | | | | | Co-authored-by: lhchavez <lhchavez@lhchavez.com>
| * | docs: stop mentioning libgit2's "master" branchNicolas Cavallari2021-06-232-7/+7
| |/ | | | | | | | | The name of libgit2's main branch is now "main" but contributing.md and release.md still reference "master" as the main branch. Fix it.
| * docs: fix incorrect comment markerEtienne Samson2021-05-271-1/+1
| |
| * docs: document core.longpaths supportEdward Thomson2021-04-141-0/+36
| |
| * cmake: rename MSVC_CRTDBG to WIN32_LEAKCHECKEdward Thomson2020-11-211-0/+4
| |
| * changelog: include new reference validity functionsethomson/name_is_validEdward Thomson2020-10-251-0/+15
| |
| * changelog: document changes since v1.1Edward Thomson2020-10-121-0/+89
| |
| * docs: add documentation for our coding stylePatrick Steinhardt2020-04-051-0/+364
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | For years, we've repeatedly had confusion about what our actual coding style is not only for newcomers, but also across the core contributors. This can mostly be attributed to the fact that we do not have any coding conventions written down. This is now a thing of the past with the introduction of a new document that gives an initial overview of our style and most important best practices for both our C codebase as well as for CMake. While the proposed coding style for our C codebase should be rather uncontroversial, the coding style for CMake might be. This can be attributed to multiple facts. First, the CMake code base doesn't really have any uniform coding style and is quite outdated in a lot of places. Second, the proposed coding style actually breaks with our existing one: we currently use all-uppercase function names and variables, but the documented coding style says we use all-lowercase function names but all-uppercase variables. It's common practice in CMake to write variables in all upper-case, and in fact all variables made available by CMake are exactly that. As variables are case-sensitive in CMake, we cannot and shouldn't break with this. In contrast, function calls are case insensitive, and modern CMake always uses all-lowercase ones. I argue we should do the same to get in line with other codebases and to reduce the likelihood of repetitive strain injuries. So especially for CMake, the proposed coding style says something we don't have yet. I'm fine with that, as the document explicitly says that it's what we want to have and not what we have right now.
| * docs: update changelog for v1.0Patrick Steinhardt2020-03-281-0/+51
| |
| * docs: update changelog for v0.99Edward Thomson2020-02-191-18/+342
| | | | | | | | | | | | Give the release a name, "Torschlusspanik" (the fear that time is running out to act). Indeed, the time is running out for changes to be included in v1.0.
| * fuzzers: Fix the documentationlhchavez2020-02-151-6/+7
| | | | | | | | Some of the commands are now out of date.
* | transports: use GIT_EAUTH for authentication failuresJosh Bleecher Snyder2020-02-071-0/+1
| | | | | | | | | | | | | | | | | | When the failure is clearly an auth failure (as opposed to possibly an auth failure), use the error code GIT_EAUTH instead of GIT_ERROR. While we're here, fix a typo and improve an error message. Fixes #5389.
* | changelog: note new error class GIT_ERROR_HTTPJosh Bleecher Snyder2020-02-071-0/+2
|/ | | | Updates #5389
* Merge pull request #5320 from josharian/minor-docsPatrick Steinhardt2019-12-131-2/+4
|\ | | | | Minor doc improvements
| * changelog: add more newly-accepted urlsJosh Bleecher Snyder2019-12-041-2/+4
| | | | | | | | | | | | | | | | | | | | | | | | I encountered some problematic URLs, and was delighted to see that they were already fixed. I figured I may as well add them to the changelog. For the record, URLs with no path used to be rejected. That is arguably correct, but command line git accepts them. URLs with a path of / and a non-standard port used to have their port completely ignored!
* | changelog: document security fixesPatrick Steinhardt2019-12-101-0/+57
|/
* release.md: note that we do two security releasesethomson/release_docsEdward Thomson2019-12-041-1/+1
| | | Note that for security releases, we update the two most recent major release branches.
* cred: separate public interface from low-level detailsEtienne Samson2019-09-131-0/+8
|
* changelog: include security updatesusers/ethomson/security_updatesEdward Thomson2019-08-131-0/+10
|
* cmake: Modulize our TLS & hash detectionEtienne Samson2019-06-141-0/+7
| | | | | | | | | | | | | | | The interactions between `USE_HTTPS` and `SHA1_BACKEND` have been streamlined. Previously we would have accepted not quite working configurations (like, `-DUSE_HTTPS=OFF -DSHA1_BACKEND=OpenSSL`) and, as the OpenSSL detection only ran with `USE_HTTPS`, the link would fail. The detection was moved to a new `USE_SHA1`, modeled after `USE_HTTPS`, which takes the values "CollisionDetection/Backend/Generic", to better match how the "hashing backend" is selected, the default (ON) being "CollisionDetection". Note that, as `SHA1_BACKEND` is still used internally, you might need to check what customization you're using it for.
* http-parser: use our bundled http-parser by defaultethomson/urlparse_empty_portEdward Thomson2019-06-131-0/+17
| | | | | | | | | | | Our bundled http-parser includes bugfixes, therefore we should prefer our http-parser until such time as we can identify that the system http-parser has these bugfixes (using a version check). Since these bugs are - at present - minor, retain the ability for users to force that they want to use the system http-parser anyway. This does change the cmake specification so that people _must_ opt-in to the new behavior knowingly.
* threading: clarify openssl default vs mbedtlsEdward Thomson2019-02-271-4/+5
|
* threading: clarify concurrency of accessEdward Thomson2019-02-271-1/+1
|
* Update threading.mdthreading-docsEtienne Samson2019-02-071-24/+15
|
* changelog: this is 0.28Edward Thomson2019-01-311-2/+2
|
* docs: document GIT_EUSER/GIT_EPASSTHROUGHEtienne Samson2019-01-281-1/+10
|
* Merge pull request #4858 from tiennou/fix/index-ext-readEdward Thomson2019-01-251-0/+3
|\ | | | | index: preserve extension parsing errors
| * index: preserve extension parsing errorsEtienne Samson2019-01-241-0/+3
| | | | | | | | | | | | | | Previously, we would clobber any extension-specific error message with an "extension is truncated" message. This makes `read_extension` correctly preserve those errors, takes responsibility for truncation errors, and adds a new message with the actual extension signature for unsupported mandatory extensions.
* | deprecation: update changelog to reflect new policiesEdward Thomson2019-01-251-6/+14
|/
* errors: update docs for giterr changesethomson/giterrEdward Thomson2019-01-223-19/+19
|
* changelog: document that we always build cdeclethomson/cdeclEdward Thomson2019-01-171-0/+3
|
* changelog: document git_merge_analysis_for_refethomson/changelogEdward Thomson2019-01-171-0/+3
|
* changelog: document openssl fixesEdward Thomson2019-01-171-0/+2
|
* changelog: document core.logallrefupdates=alwaysEdward Thomson2019-01-171-0/+2
|
* fixup! changelog: document changes since 0.27Edward Thomson2019-01-171-1/+1
|
* changelog: document changes since 0.27Edward Thomson2019-01-171-0/+87
|
View Lorry Controller Status