threads / patch / 33485

patchgit-cherry.txt: cross reference "git log --cherry"

Subject: [PATCH] git-cherry.txt: cross reference "git log --cherry"

## tl;dr

3 messages between Apr 11, 2013 and Dec 22, 2013. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

Samuel Bronson· Apr 11, 2013, 21:39 UTC · lore

I learned of "git cherry" some days ago, but only learned of --cherry and related options to "git log" today (more-or-less by chance).

If the git-cherry(1) manpage had mentioned --cherry, I would have learned of these options sooner.

Signed-off-by: Samuel Bronson <naesten@gmail.com>
---
 Documentation/git-cherry.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
Show changes to Documentation/git-cherry.txt +2 −1
diff --git a/Documentation/git-cherry.txt b/Documentation/git-cherry.txt
index f6c19c7..076fe68 100644
--- a/Documentation/git-cherry.txt
+++ b/Documentation/git-cherry.txt
@@ -62,7 +62,8 @@ OPTIONS
 
 SEE ALSO
 --------
-linkgit:git-patch-id[1]
+linkgit:git-patch-id[1],
+the `--cherry` option to linkgit:git-log[1]
 
 GIT
 ---

-- 
1.8.2.1
Samuel Bronson· Dec 19, 2013, 20:20 UTC · re: Samuel Bronson · lore

I learned of "git cherry" some days ago, but only learned of --cherry and related options to "git log" today[1] (more-or-less by chance).

If the git-cherry(1) manpage had mentioned --cherry, I would have learned of these options sooner.

[1]: Thu, 11 Apr 2013
Signed-off-by: Samuel Bronson <naesten@gmail.com>
---
 Documentation/git-cherry.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
Show changes to Documentation/git-cherry.txt +2 −1
diff --git a/Documentation/git-cherry.txt b/Documentation/git-cherry.txt
index 0ea921a..cff9ae5 100644
--- a/Documentation/git-cherry.txt
+++ b/Documentation/git-cherry.txt
@@ -138,7 +138,8 @@ $ git cherry origin/master topic base
 
 SEE ALSO
 --------
-linkgit:git-patch-id[1]
+linkgit:git-patch-id[1],
+the `--cherry` option to linkgit:git-log[1]
 
 GIT
 ---

-- 
1.8.4.3
Junio C Hamano· Dec 22, 2013, 06:58 UTC · re: Samuel Bronson · lore

Re: [PATCH] git-cherry.txt: cross reference "git log --cherry"

Samuel Bronson <naesten@gmail.com> writes:
Show 5 quoted lines
> I learned of "git cherry" some days ago, but only learned of --cherry
> and related options to "git log" today[1] (more-or-less by chance).
>
> If the git-cherry(1) manpage had mentioned --cherry, I would have
> learned of these options sooner.

This proposed log message is of an unusual style. It is curious that somebody learn "cherry" first before "log".

Show 5 quoted lines
>  SEE ALSO
>  --------
> -linkgit:git-patch-id[1]
> +linkgit:git-patch-id[1],
> +the `--cherry` option to linkgit:git-log[1]

The description text talks about "changeset (or "diff")", "compares the changeset rather than the commit id", "diffs are compared", etc., which is a hint that a lone reference to "patch-id" would be a page to read about that comparison, which is a good motivation that may entice the readers to follow that reference.

I am not sure what value the readers of this man page would see to this addition, though. Unlike the reference to patch-id, it is not so obvious what gives them motivation to follow this new reference to "log --cherry". A new sentence in DESCRIPTION section to mention it (e.g. "'log --cherry' gives similar information") may be needed at the same time.

← back to recent threads