docs


Log

Author Commit Date CI Message
Patrick Steinhardt bf3382d5 2018-07-19T15:22:18 cmake: remove need to add "-fsanitize=fuzzer" flag for fuzzers Right now, users are being instrucded to add the "-DCMAKE_EXE_LINKER_FLAGS=-fsanitize=fuzzer" flag when they want to build our fuzzers. This is error-prone and user unfriendly. Instead, just add the flag to our fuzzers' build instructions so that it happens automatically. Adjust the README accordingly.
Patrick Steinhardt ad087303 2018-07-20T14:20:07 fuzzers: move readme to docs/fuzzing.md
Patrick Steinhardt 12804c46 2018-07-20T12:24:08 cmake: remove USE_SANITIZER and USE_COVERAGE options Both the USE_SANITIZER and USE_COVERAGE options are convenience options that turn on a set of CFLAGS. Despite our own set of CFLAGS required to build libgit2, we have no real business to mess with them, though, as they can easily be passed in by the user via specifying the CFLAGS environment variable. The reasoning behind not providing them is that as soon as we start adding those for some usecases, users might ask for other sets of CFLAGS catering to their specific need in another usecase. Thus, we do not want to support them here.
Edward Thomson 243d40df 2018-06-22T19:21:22 docs: add unsaved index safety to changelog
Patrick Steinhardt 0bfe5f78 2018-06-12T10:42:53 docs: fix statement about tab width The libgit2 project mostly follows the coding style of git and thus the linux project. While those two projects use a recommended tab width of eight spaces, we instruct users to set their editor's tab width to four spaces. Fix this to say eight instead.
Edward Thomson f81923ef 2018-06-09T18:31:57 Merge branch 'pks/docs-improvements'
Edward Thomson 8a2de353 2018-06-09T18:25:46 Merge branch 'compat/clibs'
Edward Thomson 5e53f216 2018-06-09T18:24:27 docs: update release steps to include clib manifest We've introduced a manifest for the clib version system that includes a version number; we should update it at release time to correspond with the version number in the header.
Patrick Steinhardt 68a3c0b1 2018-03-22T09:20:43 docs: reorganize documents Our non-technical documents are currently floating around loosely in our project's root, making it harden than necessary to discover what one is searching for. We do have a "docs/" directory, though, which serves exactly that purpose of hosting documentation. Move our non-technical documentation into the "docs/" directory. Adjust all links to these documents.
Jason Haslam d54c34a7 2018-05-21T17:04:11 docs: added note regarding difference in treatment of junction points from git
Carson Howard 77799325 2018-05-02T07:46:53 docs: update differences-from-git to be more concise
Carson Howard 0f69a324 2018-03-30T08:43:02 docs: add documentation to state differences from the git cli
Patrick Steinhardt ad006d87 2018-02-15T11:13:14 docs: document increasing the version number for releases
Patrick Steinhardt bb7c672a 2018-02-15T11:06:40 docs: fix typo in "release.md" filename
Carlos Martín Nieto adc90b47 2018-01-27T21:00:53 docs: udpates to wording in release documentation
Carlos Martín Nieto 03569109 2018-01-17T14:42:05 docs: add release documentation This should provide the release manager enough to know which steps to take when it's time to cut a new release.
Jason Haslam afab1fff 2016-02-16T21:02:41 checkout: handle dirty submodules correctly Don't generate conflicts when checking out a modified submodule and the submodule is dirty or modified in the workdir.
Stjepan Rajko 2b96b6ef 2015-10-14T09:41:27 Fix docs typo geterr_clear -> giterr_clear
Nicolas Kaiser 27f680a9 2013-12-01T10:35:56 fix typos in docs
Russell Belfer aa94acf0 2013-09-25T11:53:02 The error handling docs are out of date The error handling docs date back to the early error redesign work and don't match up with the route we actually took. This brings them in line with actual practice both for external users and internal implementors, and notes some of the exceptions and possible bugs.
Vicent Martí b294f97e 2013-09-25T01:41:17 Merge pull request #1873 from mikeando/doc_cleanup Cleaned up some tables in checkout-internals doc
Mike Anderson 6918d81e 2013-09-25T11:14:06 Fixed formatting of diff-internals.md Indentation for lists was not working correctly.
Mike Anderson 53e0636c 2013-09-24T16:43:06 Cleaned up some tables in checkout-internals doc The markdown wasn't rendering correctly.
Russell Belfer 5dc98298 2013-06-11T11:22:22 Implement regex pattern diff driver This implements the loading of regular expression pattern lists for diff drivers that search for function context in that way. This also changes the way that diff drivers update options and interface with xdiff APIs to make them a little more flexible.
Russell Belfer 114f5a6c 2013-06-10T10:10:39 Reorganize diff and add basic diff driver This is a significant reorganization of the diff code to break it into a set of more clearly distinct files and to document the new organization. Hopefully this will make the diff code easier to understand and to extend. This adds a new `git_diff_driver` object that looks of diff driver information from the attributes and the config so that things like function content in diff headers can be provided. The full driver spec is not implemented in the commit - this is focused on the reorganization of the code and putting the driver hooks in place. This also removes a few #includes from src/repository.h that were overbroad, but as a result required extra #includes in a variety of places since including src/repository.h no longer results in pulling in the whole world.
Edward Thomson bec65a5e 2013-04-01T22:16:21 merge!
Russell Belfer 77cffa31 2013-01-02T17:14:00 Simplify checkout documentation This moves a lot of the detailed checkout documentation into a new file (docs/checkout-internals.md) and simplifies the public docs for the checkout API.
Bruce Mitchener d73c94b2 2012-05-19T20:24:55 Fix spelling errors.
Vicent Martí 845f8314 2012-02-14T20:36:39 error-handling: Add reference documentation