Skip to content
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

Add documentation generation #477

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jpoiret
Copy link

@jpoiret jpoiret commented Jun 3, 2023

This uses the manpage XSL and asciidoc config files from git 2.40.1 to build the documentation on its own. This work was done to package this in GNU Guix, inspired by the similar Debian patches [1]. This of course doesn't touch any of the maintainer stuff, but it could be transitioned to use this instead.

[1] https://salsa.debian.org/python-team/packages/git-filter-repo/-/tree/debian/latest/debian

This uses the manpage XSL and asciidoc config files from git 2.40.1.
@newren
Copy link
Owner

newren commented Jul 7, 2024

Sigh...this means yet another thing we borrow from git that will continue going further and further out of date...though it probably makes sense since those things don't get changed that often and being able to generate our own docs is nice.

It feels a little weird that when I cd into the Documentation directory and run a plain 'make', that it builds neither the man or html targets and instead runs something else. Could you fix that?

Most importantly, the commit is missing your Signed-off-by line (https://github.com/git/git/blob/master/Documentation/SubmittingPatches#L351), which is needed to accept the contribution. Can you add it?

Other than those two minor issues, the patch looks good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants