git-absorb icon indicating copy to clipboard operation
git-absorb copied to clipboard

man page contains wrong version number

Open imphil opened this issue 2 years ago • 6 comments

The man page of git absorb (v0.6.9 as available from GitHub releases for x86) says it's version 0.5.0 from 2019: https://github.com/tummychow/git-absorb/blob/764f4776f2edaea65f7b683ea0f0e96d9711fa67/Documentation/git-absorb.1#L10

I guess there's some automation missing to update the docs with the correct version number when doing a release?

imphil avatar Jan 19 '23 14:01 imphil

tsk, i don't use asciidoc myself so it's rather inconvenient for me to bump and regenerate that every time. and i'm sure as hell not editing groff by hand. i'll see if there's an easy way to fix this

tummychow avatar Jan 19 '23 20:01 tummychow

(for the record, there haven't been any interface changes since the man page was written, so it's not actually out of date, it's just annoying that groff expects every manpage to have the version and date in the footer)

tummychow avatar Jan 19 '23 20:01 tummychow

I just noticed that

  -F, --one-fixup-per-commit               Only generate one fixup per commi

is missing from the outdated man page help which is also used when executinggit help absorb.

iwittkau avatar May 02 '24 09:05 iwittkau

ugh that's because i've been forgetting to ask people to update it when they add new features. i also don't use adoc personally (and frankly i suspect most contributors don't) so we should probably regenerate the groff in a github action and attach it to a release object. more housekeeping...

tummychow avatar May 02 '24 14:05 tummychow

This bit me (the version number being wrong + not including the -F flag I specifically was hoping to find in the man page).

A friend noticed that https://crates.io/crates/clap_mangen is a thing; thought I'd suggest it in case exporting the help from clap is preferable to editing the roff. (Maybe this could be done in the GitHub Action or whatever). I've not tried it myself though.

reivilibre avatar Jul 16 '24 14:07 reivilibre

oh, good idea. i would accept a pr to switch to clap_mangen, but probably won't get to implementing it myself any time soon

tummychow avatar Jul 16 '24 22:07 tummychow