Squelch example warnings, enable CI #3897
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3360607 to
b1162d2
Compare
|
The test failure is unrelated |
| // Including the `git2.h` header will include all the other libgit2 headers | ||
| // that you need. It should be the only thing you need to include in order | ||
| // to compile properly and get all the libgit2 API. | ||
| /* [**libgit2**][lg] is a portable, pure C implementation of the Git core |
There was a problem hiding this comment.
This would hide this text from the docco output. We need C++ comments or /** here for it to show.
There was a problem hiding this comment.
Now that you mention docco: my patches have another problem in that they change the order of documentation. With these patches, we will not have a logical order of initializing the library, opening repo, etc., but instead first describe all functions and at long last initialize the library.
I guess I'll re-order this such that the single functions will go after the main function.
b1162d2 to
683155f
Compare
|
Okay, fixed up comments such that they appear in the correct order and are evaluated as documentation. |
683155f to
ec3f5a9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Recently, I wanted to build our examples and was hugely annoyed by all those warnings that were spilled left and right. So I cleaned up our tests, particularly the
examples/general.cone, so that no warnings get thrown anymore.Furthermore, I've changed CI scripts to build all tests to catch errors early on. I know that the examples aren't of huge importance, but considering they might be the first contact point with libgit2 for new developers, I'd say they should be reasonably clean and, as a bare minimum, compile. So that's why I think it is only sensible to break our CI builds when changes inside libgit2 break our examples.