-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
git-changelog: add page #7359
git-changelog: add page #7359
Conversation
This comment has been minimized.
This comment has been minimized.
pages/common/git-changelog.md
Outdated
> Part of `git-extras`. | ||
> More information: <https://github.com/tj/git-extras/blob/master/Commands.md#git-changelog>. | ||
|
||
- Update existing file or creating a new History.md file with pretty formatted output: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is a non pretty
output?
- Update existing file or creating a new History.md file with pretty formatted output: | |
- Update existing file or create a new `History.md` file with the commit messages since the latest Git tag: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I found this term ("pretty") in the man page. There there're some additional info about what kind of formatting you can do:
You could customize the changelog format via some git config options.
- git config changelog.format $format controls the format of each commit. It will be passed as git log --pretty=format:$format. The default value is `* %s`.
- git config changelog.mergeformat $format is like changelog.format but only used when --merges-only is specified. The default value is * %s%n%w(64,4,4)%b.
Do you believe that some examples of this would be useful? Or the removal of "pretty" would be best?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mfrw can you take a look at this and give me your thoughts as well?
Co-authored-by: Axel Navarro <navarroaxel@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few nitpicks :)
Co-authored-by: Muhammad Falak R Wani <falakreyaz@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
Thank you for your contribution @deadpyxel
common/
,linux/
, etc.)Version of the command being documented (if known): 6.2.0
Opened from #5137