guilt doc: use literal paragraphs for example commands
PATCH 1/1 guilt doc: use literal paragraphs for example commands
Display example commands verbatim by indenting the paragraphs.
Signed-off-by Wu Fengguang <[email protected]>
--- 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(-)
Documentation/guilt-add.txt +2 -2
@@ -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 ------
Documentation/guilt-delete.txt +1 -1
@@ -25,7 +25,7 @@ EXAMPLES -------- Delete a patch called 'foobar': -$ guilt-delete foobar + $ guilt-delete foobar Author ------
Documentation/guilt-diff.txt +1 -1
@@ -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.
Documentation/guilt-help.txt +2 -2
@@ -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 ------
Documentation/guilt-init.txt +3 -4
@@ -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 ------
Documentation/guilt-new.txt +3 -3
@@ -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 ------
Documentation/guilt-rebase.txt +2 -3
@@ -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 ------
Josef Jeff Sipek
AppliedQuoted 1 line · Wu Fengguang
Display example commands verbatim by indenting the paragraphs.
Applied.
Thanks,
Josef 'Jeff' Sipek.
Signature · 4 lines
Debugging is twice as hard as writing the code in the first place. Therefore, if you write the code as cleverly as possible, you are, by definition, not smart enough to debug it. - Brian W. Kernighan