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

man page contains wrong version number #74

Open
imphil opened this issue Jan 19, 2023 · 6 comments
Open

man page contains wrong version number #74

imphil opened this issue Jan 19, 2023 · 6 comments

Comments

@imphil
Copy link

imphil commented Jan 19, 2023

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:

.TH "GIT\-ABSORB" "1" "10/18/2019" "git\-absorb 0\&.5\&.0" "git absorb"

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

@tummychow
Copy link
Owner

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
Copy link
Owner

(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)

@iwittkau
Copy link

iwittkau commented May 2, 2024

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.

@tummychow
Copy link
Owner

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...

@reivilibre
Copy link

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.

@tummychow
Copy link
Owner

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

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

No branches or pull requests

4 participants