From: "Utku Gultopu via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Utku Gultopu <ugultopu@gmail.com>, Utku Gultopu <ugultopu@gmail.com>
Subject: [PATCH] doc: `--date` in `git-commit` accepts approxidates
Date: Tue, 23 Feb 2021 17:35:46 +0000 [thread overview]
Message-ID: <pull.969.git.git.1614101746491.gitgitgadget@gmail.com> (raw)
From: Utku Gultopu <ugultopu@gmail.com>
Document the fact that the `--date` option in `git-commit` accepts any
date format that is accepted by the `approxidate_careful` function,
which is located in `date.c`.
Signed-off-by: Utku Gultopu <ugultopu@gmail.com>
---
doc: --date in git-commit accepts approxidates
Without the documentation, it is kind of a "hidden feature", which I was
able to discover only through online forums.
I guess this patch is not ideal, because instead of properly
documenting, it refers the user to the code. However I wasn't able to
find documentation about the "approxidates" which I can link to. Please
let me know how I can improve it.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-969%2Fugultopu%2Fdocument-approxidates-for-date-argument-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-969/ugultopu/document-approxidates-for-date-argument-v1
Pull-Request: https://github.com/git/git/pull/969
Documentation/date-formats.txt | 9 +++------
Documentation/git-commit.txt | 4 +++-
2 files changed, 6 insertions(+), 7 deletions(-)
diff --git a/Documentation/date-formats.txt b/Documentation/date-formats.txt
index f1097fac69a6..8332f592e252 100644
--- a/Documentation/date-formats.txt
+++ b/Documentation/date-formats.txt
@@ -1,10 +1,7 @@
-DATE FORMATS
-------------
+DATE FORMATS[[DATES]]
+---------------------
-The `GIT_AUTHOR_DATE`, `GIT_COMMITTER_DATE` environment variables
-ifdef::git-commit[]
-and the `--date` option
-endif::git-commit[]
+The `GIT_AUTHOR_DATE` and `GIT_COMMITTER_DATE` environment variables
support the following date formats:
Git internal format::
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 17150fa7eabe..b96b7715a0a8 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -143,7 +143,9 @@ OPTIONS
the commit author is then copied from the first such commit found.
--date=<date>::
- Override the author date used in the commit.
+ Override the author date used in the commit. The '<date>' can be in
+ any format that is accepted by the `approxidate_careful` function
+ in `date.c` or the <<DATES, DATE FORMATS>> section below.
-m <msg>::
--message=<msg>::
base-commit: 966e671106b2fd38301e7c344c754fd118d0bb07
--
gitgitgadget
next reply other threads:[~2021-02-23 17:38 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-23 17:35 Utku Gultopu via GitGitGadget [this message]
2021-02-23 18:11 ` [PATCH] doc: `--date` in `git-commit` accepts approxidates Jeff King
2021-02-23 19:33 ` Junio C Hamano
2021-02-23 18:52 ` [PATCH v2] " Utku Gultopu via GitGitGadget
2021-02-23 19:06 ` Jeff King
[not found] ` <CAEeqB6kqZTft9NWtOvm3hk9bicBL7GU_WYuAGdMG1MHYMgNAxg@mail.gmail.com>
2021-02-23 19:16 ` Utku
2021-02-23 19:34 ` Junio C Hamano
2021-02-23 20:24 ` Utku
2021-02-23 20:50 ` Jeff King
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=pull.969.git.git.1614101746491.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=git@vger.kernel.org \
--cc=ugultopu@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).