git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH] guilt doc: use literal paragraphs for example commands

From
WFWu Fengguang <fengguang.wu@intel.com>
Date
Dec 18, 2008, 11:39 UTC
Message-ID
<20081218113934.GA16171@localhost>
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: Josef Jeff Sipek
Message 1 of 2 in “guilt doc: use literal paragraphs for example commands”
  1. guilt doc: use literal paragraphs for example commandsWu Fengguang, Dec 18, 2008
  2. Josef Jeff SipekDec 20, 2008

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.