]> git.ipfire.org Git - thirdparty/git.git/commit
doc: git bisect: clarify the usage of the synopsis vs actual command
authorJean-Noël Avila <jn.avila@free.fr>
Mon, 25 May 2026 10:28:23 +0000 (10:28 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 25 May 2026 11:05:44 +0000 (20:05 +0900)
commited31e2872a7306f52de1e2b9ab0065b9d91f3338
treea0e590995fae9c4739a3574781b403f10be2965c
parent50cd5219d2b63f4896a3d142f83fadf8e47a6c3b
doc: git bisect: clarify the usage of the synopsis vs actual command

The difference between a synopsis and an actual command is that the synopsis
is a more abstract representation of the command, which may include
placeholders for arguments and options. The actual command is the specific
instance of the command with all the arguments and options filled in.

The formatting of an actual command is a code block, with the command
prefixed by a dollar sign ($) to indicate that it is a command to be run in
the terminal. It can also include comments with a hash sign (#) to explain
the command or provide additional information, just like in a regular
terminal session.

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-bisect.adoc