git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Philip Oakley <philipoakley@iee.org>
To: GitList <git@vger.kernel.org>
Subject: [RFC/PATCH 1/2] Doc rebase: Describe rebase as excluding merge commits
Date: Sun, 19 May 2013 12:52:08 +0100	[thread overview]
Message-ID: <1368964329-1600-2-git-send-email-philipoakley@iee.org> (raw)
In-Reply-To: <1368964329-1600-1-git-send-email-philipoakley@iee.org>

Describe rebase in the description section.

Include a softer paraphrased version from the crytic, well-loved,
but sometimes parodied, Name description, and tell users that merge
commits are excluded by default.

Signed-off-by: Philip Oakley <philipoakley@iee.org>

---

http://article.gmane.org/gmane.comp.version-control.git/217410
http://article.gmane.org/gmane.comp.version-control.git/217495
---
 Documentation/git-rebase.txt | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index aca8405..87a8095 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -16,6 +16,10 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
+'git rebase' will transfer local commits, excluding merge commits
+by default, to the head of the branch's upstream, or onto a new base
+if given.
+
 If <branch> is specified, 'git rebase' will perform an automatic
 `git checkout <branch>` before doing anything else.  Otherwise
 it remains on the current branch.
-- 
1.8.1.msysgit.1

  reply	other threads:[~2013-05-19 11:52 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-05-19 11:52 [RFC/PATCH 0/2] Improve rebase documenation Philip Oakley
2013-05-19 11:52 ` Philip Oakley [this message]
2013-05-19 18:08   ` [RFC/PATCH 1/2] Doc rebase: Describe rebase as excluding merge commits Jonathan Nieder
2013-05-19 22:41     ` Philip Oakley
2013-05-20  4:43     ` Junio C Hamano
2013-05-20 21:55       ` Philip Oakley
2013-05-20 22:29         ` Junio C Hamano
2013-05-19 11:52 ` [RFC/PATCH 2/2] Doc rebase: describe the priority of published work Philip Oakley

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1368964329-1600-2-git-send-email-philipoakley@iee.org \
    --to=philipoakley@iee.org \
    --cc=git@vger.kernel.org \
    /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.
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 NNTP newsgroup(s).