{"thread":{"id":"17134","subject":"[PATCH/RFC] Documentation/git-blame.txt, git-gui.txt: link SEE ALSOs","startedAt":"2009-01-13T01:13:20Z","lastAt":"2009-01-13T02:05:47Z","messageCount":3,"participants":["jidanni@jidanni.org","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"100213","messageId":"87bpucovnz.fsf@jidanni.org","threadId":"17134","inReplyTo":null,"subject":"[PATCH/RFC] Documentation/git-blame.txt, git-gui.txt: link SEE ALSOs","fromName":"","fromEmail":"jidanni@jidanni.org","sentAt":"2009-01-13T01:13:20Z","receivedAt":"2009-01-13T01:13:20Z","isPatch":true,"sender":{"key":"jidanni@jidanni.org","avatar":"https://gravatar.com/avatar/36568d4af4c8d3e71627ef3b8c8d00e39065b12f29676cccd38ced75e68fa2a6?d=mp&s=160"},"body":"As git gui is heavily blame focused, we link its SEE ALSO to\ngit-blame, and add a link back while we're at it.\n\nSigned-off-by: jidanni <jidanni@jidanni.org>\n---\n Documentation/git-blame.txt |    1 +\n Documentation/git-gui.txt   |    3 +++\n 2 files changed, 4 insertions(+), 0 deletions(-)\n\ndiff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt\nindex fba374d..d71a2c3 100644\n--- a/Documentation/git-blame.txt\n+++ b/Documentation/git-blame.txt\n@@ -186,6 +186,7 @@ commit commentary), a blame viewer won't ever care.\n \n SEE ALSO\n --------\n+linkgit:git-gui[1],\n linkgit:git-annotate[1]\n \n AUTHOR\ndiff --git a/Documentation/git-gui.txt b/Documentation/git-gui.txt\nindex d0bc98b..3a71074 100644\n--- a/Documentation/git-gui.txt\n+++ b/Documentation/git-gui.txt\n@@ -105,6 +105,9 @@ linkgit:gitk[1]::\n \tand file differences.  gitk is the utility started by\n \t'git-gui''s Repository Visualize actions.\n \n+linkgit:git-blame[1]::\n+\tCommand-line blame viewer.\n+\n Other\n -----\n 'git-gui' is actually maintained as an independent project, but stable\n-- \n1.6.0.6\n"},{"id":"100216","messageId":"7v8wpgf04c.fsf@gitster.siamese.dyndns.org","threadId":"17134","inReplyTo":"87bpucovnz.fsf@jidanni.org","subject":"Re: [PATCH/RFC] Documentation/git-blame.txt, git-gui.txt: link SEE ALSOs","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2009-01-13T01:47:15Z","receivedAt":"2009-01-13T01:47:15Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"jidanni@jidanni.org writes:\n\n> As git gui is heavily blame focused, we link its SEE ALSO to\n> git-blame, and add a link back while we're at it.\n>\n> Signed-off-by: jidanni <jidanni@jidanni.org>\n> ---\n>  Documentation/git-blame.txt |    1 +\n>  Documentation/git-gui.txt   |    3 +++\n>  2 files changed, 4 insertions(+), 0 deletions(-)\n>\n> diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt\n> index fba374d..d71a2c3 100644\n> --- a/Documentation/git-blame.txt\n> +++ b/Documentation/git-blame.txt\n> @@ -186,6 +186,7 @@ commit commentary), a blame viewer won't ever care.\n>  \n>  SEE ALSO\n>  --------\n> +linkgit:git-gui[1],\n>  linkgit:git-annotate[1]\n>  \n>  AUTHOR\n> diff --git a/Documentation/git-gui.txt b/Documentation/git-gui.txt\n> index d0bc98b..3a71074 100644\n> --- a/Documentation/git-gui.txt\n> +++ b/Documentation/git-gui.txt\n> @@ -105,6 +105,9 @@ linkgit:gitk[1]::\n>  \tand file differences.  gitk is the utility started by\n>  \t'git-gui''s Repository Visualize actions.\n>  \n> +linkgit:git-blame[1]::\n> +\tCommand-line blame viewer.\n> +\n>  Other\n>  -----\n>  'git-gui' is actually maintained as an independent project, but stable\n\nAs a general principle, I tend to refrain from referring to X from the\ndescription of Y only because X happens to use Y heavily.\n\nReferring people who heavily use Y to an alternative, which is X, hoping\nthat X may give a better user experience in certain environments is a\ndifferent matter, but in such a case, I'd rather see not just link but\nin-text description as well (study the way \"log -S\" is suggested in the\ndescription part for an example).  The attached patch shows you how.\n\nOn the other hand, what X does using Y sometimes may be easier to\nunderstand if the reader is familiar with the way how Y works.  Even in\nsuch a case, I think the documentation of X should be self contained\nenough and ideally it shouldn't have to refer to Y.  And in the case of\ngit-gui documentation, I think it is.\n\nSo I am moderately negative about the first hunk of this patch as-is, and\nI'll leave the decision on the second hunk to Shawn.\n\n\n\ndiff --git i/Documentation/git-blame.txt w/Documentation/git-blame.txt\nindex fba374d..ff7bbfb 100644\n--- i/Documentation/git-blame.txt\n+++ w/Documentation/git-blame.txt\n@@ -36,6 +36,11 @@ $ git log --pretty=oneline -S'blame_usage'\n ea4c7f9bf69e781dd0cd88d2bccb2bf5cc15c9a7 git-blame: Make the output\n -----------------------------------------------------------------------------\n \n+People working in GUI environment may find linkgit:git-gui[1] an useful\n+alternative that provides an interactive interface to the history of\n+each line.  It uses this command as an underlying engine.\n+\n+\n OPTIONS\n -------\n include::blame-options.txt[]\n"},{"id":"100221","messageId":"873afoot8k.fsf@jidanni.org","threadId":"17134","inReplyTo":"7v8wpgf04c.fsf@gitster.siamese.dyndns.org","subject":"Re: [PATCH/RFC] Documentation/git-blame.txt, git-gui.txt: link SEE ALSOs","fromName":"","fromEmail":"jidanni@jidanni.org","sentAt":"2009-01-13T02:05:47Z","receivedAt":"2009-01-13T02:05:47Z","isPatch":true,"sender":{"key":"jidanni@jidanni.org","avatar":"https://gravatar.com/avatar/36568d4af4c8d3e71627ef3b8c8d00e39065b12f29676cccd38ced75e68fa2a6?d=mp&s=160"},"body":"OK, JCH's (and Shawn's, if any forthcoming :-)) patches look better than mine.\nPlease apply them. Thanks.\n"}]}