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

Date in manpage is out of sync with commit/release date #315

Closed
gnomon- opened this issue Jul 29, 2024 · 2 comments · Fixed by #316
Closed

Date in manpage is out of sync with commit/release date #315

gnomon- opened this issue Jul 29, 2024 · 2 comments · Fixed by #316

Comments

@gnomon-
Copy link

gnomon- commented Jul 29, 2024

In trurl.1, as of commit 0942de3, the man page specifies that the date of the manual is 2023-04-27:

$ grep -E '^\.TH trurl 1' trurl.1
.TH trurl 1 "April 27, 2023" "trurl" "trurl Manual"

It could be possible to add a step in the Makefile that updates this value as necessary to match the date of the repo commit at compilation time, e.g. with something like:

git log -n1 HEAD --date=format:'%B %d, %Y' --pretty=format:'%ad'

...which for that same aforementioned commit would yield..:

July 29, 2024

I also find it useful that the git.1 man page includes the release version in it, which lets me quickly check if the version I have compiled and installed from source is the one I expected, but the extra complication required to achieve this might not be worth the trouble.

@bagder
Copy link
Member

bagder commented Jul 29, 2024

Fair. It is time to create a script to run at release time to fixup the files as necessary: the date/version in trurl.1 and the version in version.h.

bagder added a commit that referenced this issue Jul 29, 2024
- updates trurl.1 and version.h accordingly

- update RELEASE-PROCEDURE.md to mention this

Reported-by: gnomon- on github
Fixes #315
@bagder bagder closed this as completed in ee83b01 Jul 29, 2024
@gnomon-
Copy link
Author

gnomon- commented Jul 29, 2024

You are a gentleman and a scholar, sir.

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 a pull request may close this issue.

2 participants