Skip to content

doc: convert git-stash, git tag and git worktree to synopis style

Jean-Noël Avila via GitGitGadget git 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest3 patches 5 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/3doc: convert git-stash.adoc to synopis styleDocumentation/config/stash.adoc Documentation/git-stash.adoc+85 -785 replies
2/3doc: convert git tag to synopsis styleDocumentation/config/tag.adoc Documentation/git-tag.adoc+104 -910 replies
3/3doc: convert git worktree to synopsis styleDocumentation/config/worktree.adoc Documentation/git-worktree.adoc+91 -840 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/3] doc: convert git-stash, git tag and git worktree to synopis style

* Switch the synopsis to a synopsis block which will automatically format placeholders in italics and keywords in monospace
* Use instead of 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 CONFIGURATION section when it is missing and do not refer to the man page in the description of settings when this list is included in the manual page.

Jean-Noël Avila (3):
doc: convert git-stash.adoc to synopis style
doc: convert git tag to synopsis style
doc: convert git worktree to synopsis style

 Documentation/config/stash.adoc    |  29 +++--
 Documentation/config/tag.adoc      |  22 ++--
 Documentation/config/worktree.adoc |  14 +--
 Documentation/git-stash.adoc       | 134 +++++++++++-----------
 Documentation/git-tag.adoc         | 173 +++++++++++++++--------------
 Documentation/git-worktree.adoc    | 161 ++++++++++++++-------------
 6 files changed, 280 insertions(+), 253 deletions(-)

base-commit: 5099f64a82ccc80f3c6567589bfeb5e9a1b9fd6b
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1969%2Fjnavila%2Fdoc_git_stash-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1969/jnavila/doc_git_stash-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1969

Signature · 1 line
gitgitgadget