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 0/2] Improve rebase documenation
Date: Sun, 19 May 2013 12:52:07 +0100	[thread overview]
Message-ID: <1368964329-1600-1-git-send-email-philipoakley@iee.org> (raw)

Recent discussions have shown that rebase isn't as well understood as
as perhaps it should be for the basic user. 

Add a softer introductory paragraph to the man page description, and
in the second patch, add a second paragraph explaining the build up of
the command so that users have a historical context in which to
rationalise the command structure.

The second patch/paragraph will probably need the quoting checking as
to which are quoting the generic command and which are the same text
as a command example.

Basic wording is borrowed from on-list clarifications.

Philip Oakley (2):
  Doc rebase: Describe rebase as excluding merge commits
  Doc rebase: describe the priority of published work

 Documentation/git-rebase.txt | 10 ++++++++++
 1 file changed, 10 insertions(+)

-- 
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 Philip Oakley [this message]
2013-05-19 11:52 ` [RFC/PATCH 1/2] Doc rebase: Describe rebase as excluding merge commits Philip Oakley
2013-05-19 18:08   ` 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-1-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).