From: Wu Fengguang <fengguang.wu@intel.com>
To: Josef Jeff Sipek <jeffpc@josefsipek.net>
Cc: "git@vger.kernel.org" <git@vger.kernel.org>
Subject: [PATCH] guilt doc: use literal paragraphs for example commands
Date: Thu, 18 Dec 2008 19:39:34 +0800 [thread overview]
Message-ID: <20081218113934.GA16171@localhost> (raw)
Display example commands verbatim by indenting the paragraphs.
Signed-off-by: Wu Fengguang <fengguang.wu@intel.com>
---
Documentation/guilt-add.txt | 4 ++--
Documentation/guilt-delete.txt | 2 +-
Documentation/guilt-diff.txt | 2 +-
Documentation/guilt-help.txt | 4 ++--
Documentation/guilt-init.txt | 7 +++----
Documentation/guilt-new.txt | 6 +++---
Documentation/guilt-rebase.txt | 5 ++---
7 files changed, 14 insertions(+), 16 deletions(-)
--- guilt.orig/Documentation/guilt-add.txt
+++ guilt/Documentation/guilt-add.txt
@@ -23,8 +23,8 @@ EXAMPLES
Create and add a new file example.c
-$ touch example.c
-$ guilt-add example.c
+ $ touch example.c
+ $ guilt-add example.c
Author
------
--- guilt.orig/Documentation/guilt-delete.txt
+++ guilt/Documentation/guilt-delete.txt
@@ -25,7 +25,7 @@ EXAMPLES
--------
Delete a patch called 'foobar':
-$ guilt-delete foobar
+ $ guilt-delete foobar
Author
------
--- guilt.orig/Documentation/guilt-diff.txt
+++ guilt/Documentation/guilt-diff.txt
@@ -18,7 +18,7 @@ OPTIONS
-------
-z::
Output a interdiff against the top-most applied patch. This should
- produce the same diff as "guilt-new -f foo".
+ produce the same diff as "+guilt-new -f foo+".
<path>...::
Restrict diff output to a given set of files.
--- guilt.orig/Documentation/guilt-help.txt
+++ guilt/Documentation/guilt-help.txt
@@ -18,11 +18,11 @@ EXAMPLES
Open the guilt-status man page
-$ guilt-help status
+ $ guilt-help status
Open the guilt man page
-$ guilt-help
+ $ guilt-help
Author
------
--- guilt.orig/Documentation/guilt-init.txt
+++ guilt/Documentation/guilt-init.txt
@@ -17,13 +17,12 @@ EXAMPLES
--------
First, get a repository to work on. Here's one that we'll use as an example:
-$ git-clone git://git.kernel.org/pub/scm/linux/kernel/jsipek/guilt-hello.git
+ $ git-clone git://git.kernel.org/pub/scm/linux/kernel/jsipek/guilt-hello.git
Now, it initialize the patches directory using guilt's init command:
-$ cd hello
-
-$ guilt-init
+ $ cd hello
+ $ guilt-init
Author
------
--- guilt.orig/Documentation/guilt-new.txt
+++ guilt/Documentation/guilt-new.txt
@@ -42,16 +42,16 @@ EXAMPLES
Create a new patch called 'foobar':
-$ guilt-new foobar
+ $ guilt-new foobar
Create a patch called 'foo' and supply a patch description interactively:
-$ guilt-new -e foo
+ $ guilt-new -e foo
Create a patch called 'bar' with a provided patch description and sign off
on the patch:
-$ guilt-new -s -m patch-fu bar
+ $ guilt-new -s -m patch-fu bar
Author
------
--- guilt.orig/Documentation/guilt-rebase.txt
+++ guilt/Documentation/guilt-rebase.txt
@@ -24,9 +24,8 @@ EXAMPLES
Rebase current tree against Linus's 2.6 tree
-$ git-fetch git://git.kernel.org/pub/scm/linux/kernel/git/tovalds/linux-2.6.git
-
-$ guilt-rebase FETCH_HEAD
+ $ git-fetch git://git.kernel.org/pub/scm/linux/kernel/git/tovalds/linux-2.6.git
+ $ guilt-rebase FETCH_HEAD
Author
------
next reply other threads:[~2008-12-18 11:41 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-12-18 11:39 Wu Fengguang [this message]
2008-12-20 4:33 ` [PATCH] guilt doc: use literal paragraphs for example commands Josef Jeff Sipek
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=20081218113934.GA16171@localhost \
--to=fengguang.wu@intel.com \
--cc=git@vger.kernel.org \
--cc=jeffpc@josefsipek.net \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.