[PATCH] doc/git-reset: add reference to git-stash

[PATCH] doc/git-reset: add reference to git-stash

[Markus Heidelberg]

The "Interrupted workflow" situation is a good example for using
git-stash.

Signed-off-by: Markus Heidelberg <markus.heidelberg@web.de>
---
 Documentation/git-reset.txt |    2 ++
 1 files changed, 2 insertions(+), 0 deletions(-)

diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt
index 52aab5e..29156f6 100644
--- a/Documentation/git-reset.txt
+++ b/Documentation/git-reset.txt
@@ -177,6 +177,8 @@ $ git reset                                       <3>
 <3> At this point the index file still has all the WIP changes you
     committed as 'snapshot WIP'.  This updates the index to show your
     WIP files as uncommitted.
++
+See also linkgit:git-stash[1].
 
 Reset a single file in the index::
 +
-- 
1.6.1.rc3.23.gaf48b

Re: [PATCH] doc/git-reset: add reference to git-stash

[Miklos Vajna]

[-- Attachment #1: Type: text/plain, Size: 848 bytes --]

On Wed, Dec 17, 2008 at 03:59:36AM +0100, Markus Heidelberg <markus.heidelberg@web.de> wrote:
> ++
> +See also linkgit:git-stash[1].

Manpages have a dedicated "SEE-ALSO" section. What about this?

(See Documentation/git-commit.txt for an example.)

---
 Documentation/git-reset.txt |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)

diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt
index 52aab5e..e7ddc43 100644
--- a/Documentation/git-reset.txt
+++ b/Documentation/git-reset.txt
@@ -195,6 +195,10 @@ $ git add frotz.c                           <3>
 <2> This commits all other changes in the index.
 <3> Adds the file to the index again.
 
+SEE ALSO
+--------
+linkgit:git-stash[1]
+
 Author
 ------
 Written by Junio C Hamano <gitster@pobox.com> and Linus Torvalds <torvalds@osdl.org>

[-- Attachment #2: Type: application/pgp-signature, Size: 197 bytes --]

Re: [PATCH] doc/git-reset: add reference to git-stash

[Markus Heidelberg]

Miklos Vajna, 17.12.2008:
> On Wed, Dec 17, 2008 at 03:59:36AM +0100, Markus Heidelberg <markus.heidelberg@web.de> wrote:
> > ++
> > +See also linkgit:git-stash[1].
> 
> Manpages have a dedicated "SEE-ALSO" section. What about this?

That's only appropriate if the commands are generally related to each
other, which isn't true for git-reset and git-stash.

> (See Documentation/git-commit.txt for an example.)

man git-commit
/See
-> I get 4 search matches outside of the "SEE ALSO" section and it makes
sense in these cases.

Markus

Re: [PATCH] doc/git-reset: add reference to git-stash

[Miklos Vajna]

[-- Attachment #1: Type: text/plain, Size: 490 bytes --]

On Wed, Dec 17, 2008 at 09:49:42AM +0100, Markus Heidelberg <markus.heidelberg@web.de> wrote:
> Miklos Vajna, 17.12.2008:
> > On Wed, Dec 17, 2008 at 03:59:36AM +0100, Markus Heidelberg <markus.heidelberg@web.de> wrote:
> > > ++
> > > +See also linkgit:git-stash[1].
> > 
> > Manpages have a dedicated "SEE-ALSO" section. What about this?
> 
> That's only appropriate if the commands are generally related to each
> other, which isn't true for git-reset and git-stash.

Ah, OK.

[-- Attachment #2: Type: application/pgp-signature, Size: 197 bytes --]