]> git.ipfire.org Git - thirdparty/git.git/commit
doc: convert git worktree to synopsis style
authorJean-Noël Avila <jn.avila@free.fr>
Sun, 5 Oct 2025 21:11:42 +0000 (21:11 +0000)
committerJunio C Hamano <gitster@pobox.com>
Sun, 5 Oct 2025 23:09:03 +0000 (16:09 -0700)
commit0ae23ab57f9a59975ad0c628c5d141cee3ca2fd5
tree49c0903f667e2817bcedcf1d782487f9a448706c
parent0fc3a21a9e9259b942050ed8dc67a04f2371d36b
doc: convert git worktree to synopsis style

- Switch the synopsis to a synopsis block which will automatically
  format placeholders in italics and keywords in monospace
- Use _<placeholder>_ instead of <placeholder> in the description
- Use `backticks` for keywords and more complex option
descriptions. The new rendering engine will apply synopsis rules to
these spans.

Also add the config section in the manual page and do not refer to the man
page in the description of settings when this description is already in the
man page.

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