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

[PATCHv2] git-rm.txt: Fix quoting

From
Michael J Gruber <git@drmicha.warpmail.net>
Date
Dec 8, 2010, 11:15 UTC
Message-ID
<73d13b752212b557c0dc157edea9a62122840e93.1291806379.git.git@drmicha.warpmail.net>
In-Reply-To
<20101207172542.GA25827@sigill.intra.peff.net>

Literal " produces typographically incorrect quotations, but "works" in most circumstances. In the subheadings of git-rm.txt, it "works" for the html backend but not for the docbook conversion to nroff: double "" and spurious double spaces appear in the output.

Replace "incorrect" quotations by ``correct'' ones, and fix other "quotations" which are really 'command names' resp. plain words.

This should make git-rm.txt "-clean.
Reported-by: Jeff King <peff@peff.net>
Helped-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
---
While we don't need to match the underlines to the header's length, it
looks nicer. So v2 incorporates this and the other changes:
- untar is not a command on proper OSs
- rsync is not a complete command line (implicit style guide...)
 Documentation/git-rm.txt |   12 ++++++------
 1 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt
index 71e3d9f..0adbe8b 100644
--- a/Documentation/git-rm.txt
+++ b/Documentation/git-rm.txt
@@ -89,8 +89,8 @@ the paths that have disappeared from the filesystem. However,
 depending on the use case, there are several ways that can be
 done.
 
-Using "git commit -a"
-~~~~~~~~~~~~~~~~~~~~~
+Using ``git commit -a''
+~~~~~~~~~~~~~~~~~~~~~~~
 If you intend that your next commit should record all modifications
 of tracked files in the working tree and record all removals of
 files that have been removed from the working tree with `rm`
@@ -98,8 +98,8 @@ files that have been removed from the working tree with `rm`
 automatically notice and record all removals.  You can also have a
 similar effect without committing by using `git add -u`.
 
-Using "git add -A"
-~~~~~~~~~~~~~~~~~~
+Using ``git add -A''
+~~~~~~~~~~~~~~~~~~~~
 When accepting a new code drop for a vendor branch, you probably
 want to record both the removal of paths and additions of new paths
 as well as modifications of existing paths.
@@ -111,8 +111,8 @@ tree using this command:
 git ls-files -z | xargs -0 rm -f
 ----------------
 
-and then "untar" the new code in the working tree. Alternately
-you could "rsync" the changes into the working tree.
+and then untar the new code in the working tree. Alternately
+you could 'rsync' the changes into the working tree.
 
 After that, the easiest way to record all removals, additions, and
 modifications in the working tree is:
-- 
1.7.3.2.662.g6fd5b8.dirty
Previous: Jeff KingNext: Junio C Hamano
Message 8 of 9 in “[BUG] yet another doc formatting problem”
  1. Jeff KingDec 7, 2010
  2. Michael J GruberDec 7, 2010
  3. git-rm.txt: Fix quotingMichael J Gruber, Dec 7, 2010
  4. Jeff KingDec 7, 2010
  5. Michael J GruberDec 8, 2010
  6. Jonathan NiederDec 7, 2010
  7. Jeff KingDec 7, 2010
  8. [PATCHv2] git-rm.txt: Fix quotingMichael J Gruber, Dec 8, 2010
  9. Junio C HamanoDec 7, 2010

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.