git-filter-repo icon indicating copy to clipboard operation
git-filter-repo copied to clipboard

Add documentation generation

Open jpoiret opened this issue 2 years ago • 1 comments

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

jpoiret avatar Jun 03 '23 13:06 jpoiret

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.

newren avatar Jul 07 '24 03:07 newren