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

2013-12-21 Thread Junio C Hamano
Samuel Bronson naes...@gmail.com writes:

 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.

  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.


--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


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

2013-04-11 Thread Samuel Bronson
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 naes...@gmail.com
---
 Documentation/git-cherry.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

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

--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html