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

Re: Minor man page weirdness?

From
Junio C Hamano <gitster@pobox.com>
Date
Oct 18, 2017, 02:34 UTC
Message-ID
<xmqqfuahkwug.fsf@gitster.mtv.corp.google.com>
In-Reply-To
<xmqq1sm1o5k5.fsf@gitster.mtv.corp.google.com>
Junio C Hamano <gitster@pobox.com> writes:
Show 13 quoted lines
> Andreas Schwab <schwab@linux-m68k.org> writes:
>
>> On Okt 16 2017, Jeff King <peff@peff.net> wrote:
>>
>>> We do have some hacks/workarounds for broken versions of the toolchain.
>>> You can try tweaking various knobs you find in Documentation/Makefile).
>>> DOCBOOK_SUPPRESS_SP sounds promising, but I think it actually does the
>>> opposite (removes extra spaces).
>>
>> An easy workaround would be to add a comma between `-f` and 'git
>> branch'.
>
> That sounds like a good idea, regardless of the mark-up issue.

-- >8 -- branch doc: sprinkle a few commas for readability

The "--force" option can also be used when the named branch does not yet exist, and the point of the option is the user can (re)point the branch to the named commit even if it does. Add 'even' before 'if' to clarify. Also, insert another comma after "Without -f" before "the command refuses..." to make the text easier to parse.

Incidentally, this change should help certain versions of docbook-xsl-stylesheets that renders the original without any whitespace between "-f" and "git".

Noticed-by: Lars Schneider <larsxschneider@gmail.com>
Helped-by: Jeff King <peff@peff.net>
Helped-by: Andreas Schwab <schwab@suse.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/git-branch.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index fe029ac6fc..d6587c5e96 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -104,8 +104,8 @@ OPTIONS
 
 -f::
 --force::
-	Reset <branchname> to <startpoint> if <branchname> exists
-	already. Without `-f` 'git branch' refuses to change an existing branch.
+	Reset <branchname> to <startpoint>, even if <branchname> exists
+	already. Without `-f`, 'git branch' refuses to change an existing branch.
 	In combination with `-d` (or `--delete`), allow deleting the
 	branch irrespective of its merged status. In combination with
 	`-m` (or `--move`), allow renaming the branch even if the new
Previous: Junio C HamanoNext: Jeff King
Message 12 of 16 in “Minor man page weirdness?”
  1. Lars SchneiderOct 16, 2017
  2. Jeff KingOct 16, 2017
  3. Andreas SchwabOct 17, 2017
  4. Jeff KingOct 17, 2017
  5. Andreas SchwabOct 17, 2017
  6. Jeff KingOct 17, 2017
  7. Andreas SchwabOct 17, 2017
  8. Jeff KingOct 17, 2017
  9. Andreas SchwabOct 17, 2017
  10. Andreas SchwabOct 17, 2017
  11. Junio C HamanoOct 17, 2017
  12. Junio C HamanoOct 18, 2017
  13. Jeff KingOct 18, 2017
  14. Junio C HamanoOct 18, 2017
  15. Jeff KingOct 18, 2017
  16. Lars SchneiderOct 19, 2017

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.