Documentation: Update documentation for git commit --date

[jpninanjohn]

Adding special strings that can be given as date for git

Signed-off-by: Ninan John jninan@thoughtworks.com

Thanks for taking the time to contribute to Git! Please be advised that the
Git community does not use github.com for their contributions. Instead, we use
a mailing list (git@vger.kernel.org) for code submissions, code reviews, and
bug reports. Nevertheless, you can use GitGitGadget (https://gitgitgadget.github.io/)
to conveniently send your Pull Requests commits to our mailing list.

Please read the "guidelines for contributing" linked above!

[gitgitgadget]

Welcome to GitGitGadget

Hi @jpninanjohn, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests.

Please make sure that this Pull Request has a good description, as it will be used as cover letter.

Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

• the lines should not exceed 76 columns,
• the first line should be like a header and typically start with a prefix like "tests:" or "commit:", and
• the commit messages' body should be describing the "why?" of the change.
• Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code.

Contributing the patches

Before you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a PR comment of the form /allow <username>.

Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment /submit.

After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions.

If you want to see what email(s) would be sent for a submit request, add a PR comment /preview to have the email(s) sent to you. You must have a public GitHub email address for this.

If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox ("raw") file corresponding to the mail you want to reply to from the Git mailing list. If you use GMail, you can upload that raw mbox file via:

curl -g --user "<EMailAddress>:<Password>" --url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txt

[dscho]

/allow

[gitgitgadget]

User jpninanjohn is now allowed to use GitGitGadget.

[dscho]

I wonder whether it would make sense to add an exhaustive list (with possible clarifications e.g. for tea) to Documentation/date-formats.txt, and then reference the "DATE FORMATS" section in this hunk?

For extra brownie points, this reference could be in the form of See <<DATE-FORMATS>> and add a [[DATE-FORMATS]] before the first line of Documentation/date-formats.txt, for extra markup goodness.

[jpninanjohn]

Is there an exhaustive list available anywhere?

[dscho]

Only in the source code, I would think.

clicketyclick

https://github.com/git/git/blob/v2.23.0/date.c#L1099-L1112

[dscho]

Please note that there is a strong preference to continue in lower-case after the colon in the first line of the commit message: "Documentation: update [...]" instead of "Documentation: Update [...]".

[jpninanjohn]

Please note that there is a strong preference to continue in lower-case after the colon in the first line of the commit message: "Documentation: update [...]" instead of "Documentation: Update [...]".

Will change it