Skip to content

/ libgit2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

missing reference docs on website for functions in include/git2/sys/repository.h #5221

Open
josharian opened this issue Sep 7, 2019 · 4 comments
Open

missing reference docs on website for functions in include/git2/sys/repository.h #5221

josharian opened this issue Sep 7, 2019 · 4 comments
Labels
documentation

Comments

@josharian
Copy link
Contributor

@josharian josharian commented Sep 7, 2019

Reproduction steps

Visit https://libgit2.org/libgit2/#HEAD. Look for git_repository_set_refdb. It is not present, nor are any of the functions I checked from include/git2/sys/repository.h.

Version of libgit2 (release number or SHA1)

Whatever the website is at as of Sep 6, 2019. (Perhaps the website should provide a sha indicating what HEAD is?)
@ethomson
Copy link
Member

@ethomson ethomson commented Sep 9, 2019

Apologies for that. @tiennou might know why that's not working.
@tiennou
Copy link
Contributor

@tiennou tiennou commented Sep 9, 2019

Sounds like the missing -I to make "git2/sys/" includes work, which is in one of the docurium PRs.

In the meantime, my own docurium generator seems to see it, so feel free to use that instead.
@ethomson
Copy link
Member

@ethomson ethomson commented Sep 9, 2019

We need to get this stuff included. @carlosmn what's the status here? Do you want to review it? Should we just merge it?
@tiennou
Copy link
Contributor

@tiennou tiennou commented Sep 9, 2019

Re-reading the current PRs & code, I think it was fixed by libgit2/docurium#45, so it ought to be missing only because we're not using master docurium when building the docs — I've checked that it shows up in that case.

Right now I only have PRs left for simple optimizations, some CLI niceties, better behaved parallelism, an undocument-checker, and "only-missing" mode, which I've just published but still depends on the messy tweaks branch. Not sure how critical they are though, now that the clang context in docurium is saner…
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
@josharian @tiennou @ethomson
You can’t perform that action at this time.