git-for-windows/git
1
0
Fork 0
mirror of https://github.com/git-for-windows/git.git synced 2026-04-05 13:01:04 -05:00
Code Issues Packages Projects Releases 335 Wiki Activity
Files
daa91c693eb1fef0cd04aed8c6b37ee79d5897e0
git/Documentation
History
Kristoffer Haugsbakk daa91c693e doc: interpret-trailers: convert to synopsis style 
See e.g. 0ae23ab5 (doc: convert git worktree to synopsis style,
2025-10-05) for the markup rules for this style.

There aren’t many subtleties to the transformation of this doc since it
doesn’t use any advanced constructs. The only thing is that "`:`{nbsp}" is
used instead of `': '` to refer to effective inline-verbatim with
a space (␠).[1] I also use (_) for emphasis although (') gives the
same result.

Also prefer linking to Git commands instead of saying e.g. `git
format-patch`. But for this command we can type out git-interpret-
trailers(1) to avoid a self-reference.

Also replace camel case `<keyAlias>` with kebab case `<key-alias>`.
And while doing that make sure to replace `trailer.*` with
`trailer.<key-alias>`.

† 1: Similar to "`tag:`{nbsp}" in `Documentation/pretty-formats.adoc`

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2026-03-16 15:04:37 -07:00
..
config
Merge branch 'mh/doc-core-attributesfile'
2025-12-30 12:58:19 +09:00
howto
meson: make GIT_HTML_PATH configurable
2025-11-06 09:58:56 -08:00
includes
…
mergetools
doc: check well-formedness of delimited sections
2025-08-11 14:16:03 -07:00
RelNotes
RelNotes: fully spell negation
2026-02-01 18:07:39 -08:00
technical
Merge branch 'en/xdiff-cleanup-2'
2025-12-05 14:49:56 +09:00
.gitignore
…
asciidoc.conf.in
doc: git-log: convert rev list options to new doc format
2025-07-07 13:45:00 -07:00
asciidoctor-extensions.rb.in
doc: git-log: convert rev list options to new doc format
2025-07-07 13:45:00 -07:00
blame-options.adoc
doc: blame-options: convert to new doc format
2026-01-09 06:15:31 -08:00
BreakingChanges.adoc
refs/files: deprecate writing symrefs as symbolic links
2025-10-15 09:11:08 -07:00
build-docdep.perl
doc: fix build-docdep.perl
2025-03-01 10:26:15 -08:00
cat-texi.perl
…
cmd-list.sh
Documentation: stop depending on Perl to generate command list
2025-04-16 07:30:30 -07:00
CodingGuidelines
Documentation: note styling for bit fields
2025-08-26 15:46:03 -07:00
config.adoc
Merge branch 'jc/doc-includeif-hasconfig-remote-url-fix' into maint-2.51
2025-10-15 10:29:34 -07:00
date-formats.adoc
…
DecisionMaking.adoc
…
diff-algorithm-option.adoc
blame: make diff algorithm configurable
2025-11-17 09:31:59 -08:00
diff-context-options.adoc
add-patch: add diff.context command line overrides
2025-07-29 08:52:45 -07:00
diff-format.adoc
doc: check well-formedness of delimited sections
2025-08-11 14:16:03 -07:00
diff-generate-patch.adoc
Merge branch 'ma/doc-diff-cc-headers'
2025-06-18 13:53:34 -07:00
diff-options.adoc
blame: make diff algorithm configurable
2025-11-17 09:31:59 -08:00
doc-diff
…
docbook-xsl.css
…
docbook.xsl
…
docinfo-html.in
…
everyday.adoco
…
fetch-options.adoc
doc: convert git pull to synopsis style
2025-11-19 15:00:42 -08:00
fix-texi.sh
Documentation: stop depending on Perl to massage user manual
2025-04-16 07:30:29 -07:00
for-each-ref-options.adoc
Merge branch 'ja/doc-lint-sections-and-synopsis'
2025-08-25 14:22:02 -07:00
fsck-msgids.adoc
builtin/fsck: move generic HEAD check into refs_fsck()
2026-01-12 06:55:41 -08:00
generate-mergetool-list.sh
…
git-add.adoc
add-patch: fully document option P
2025-10-21 14:35:44 -07:00
git-am.adoc
Merge branch 'kh/doc-committer-date-is-author-date'
2025-12-05 14:49:57 +09:00
git-annotate.adoc
…
git-apply.adoc
apply docs: clarify wording for --intent-to-add
2025-07-07 06:41:11 -07:00
git-archimport.adoc
…
git-archive.adoc
…
git-backfill.adoc
doc: check for absence of the form --[no-]parameter
2025-08-11 14:16:04 -07:00
git-bisect-lk2009.adoc
…
git-bisect.adoc
bisect: update usage and docs to match each other
2025-10-28 15:41:42 -07:00
git-blame.adoc
doc: git-blame: convert to new doc format
2026-01-09 06:15:53 -08:00
git-branch.adoc
doc: branch: fix inline-verbatim
2025-05-05 10:48:07 -07:00
git-bugreport.adoc
…
git-bundle.adoc
…
git-cat-file.adoc
doc: check for absence of the form --[no-]parameter
2025-08-11 14:16:04 -07:00
git-check-attr.adoc
doc: check for absence of multiple terms in each entry of desc list
2025-08-11 14:16:04 -07:00
git-check-ignore.adoc
doc: check for absence of multiple terms in each entry of desc list
2025-08-11 14:16:04 -07:00
git-check-mailmap.adoc
…
git-check-ref-format.adoc
doc: check for absence of the form --[no-]parameter
2025-08-11 14:16:04 -07:00
git-checkout-index.adoc
…
git-checkout.adoc
doc: fix asciidoc markup issues in several files
2025-12-20 14:55:43 +09:00
git-cherry-pick.adoc
…
git-cherry.adoc
…
git-citool.adoc
…
git-clean.adoc
…
git-clone.adoc
Merge branch 'kr/clone-synopsis-fix' into maint-2.51
2025-10-15 10:29:32 -07:00
git-column.adoc
doc: column: fix blank lines around block delimiters
2025-06-01 17:20:16 -07:00
git-commit-graph.adoc
commit-graph: add new config for changed-paths & recommend it in scalar
2025-10-22 10:40:11 -07:00
git-commit-tree.adoc
…
git-commit.adoc
doc: commit: link to git-status(1) on all format options
2025-11-14 08:56:35 -08:00
git-config.adoc
Merge branch 'ps/config-doc-get-urlmatch-fix'
2026-01-21 16:16:28 -08:00
git-count-objects.adoc
Merge branch 'ds/doc-count-objects-fix' into maint-2.51
2025-10-14 13:40:54 -07:00
git-credential-cache--daemon.adoc
…
git-credential-cache.adoc
Merge branch 'bc/doc-adoc-not-txt'
2025-02-14 17:53:47 -08:00
git-credential-store.adoc
…
git-credential.adoc
…
git-cvsexportcommit.adoc
…
git-cvsimport.adoc
…
git-cvsserver.adoc
doc: add a blank line around block delimiters
2025-03-10 09:58:06 -07:00
git-daemon.adoc
git-daemon doc: update mark-up of synopsis option descriptions
2025-05-12 09:25:26 -07:00
git-describe.adoc
…
git-diagnose.adoc
…
git-diff-files.adoc
…
git-diff-index.adoc
…
git-diff-pairs.adoc
builtin/diff-pairs: allow explicit diff queue flush
2025-03-03 08:17:47 -08:00
git-diff-tree.adoc
…
git-diff.adoc
diff --no-index: support limiting by pathspec
2025-05-22 14:20:11 -07:00
git-difftool.adoc
doc: check for absence of the form --[no-]parameter
2025-08-11 14:16:04 -07:00
git-fast-export.adoc
fast-(import|export): improve on commit signature output format
2025-07-09 16:08:29 -07:00
git-fast-import.adoc
fast-import: add 'strip-if-invalid' mode to --signed-commits=<mode>
2025-11-26 08:43:44 -08:00
git-fetch-pack.adoc
…
git-fetch.adoc
doc: convert git fetch to synopsis style
2025-11-19 15:00:37 -08:00
git-filter-branch.adoc
…
git-fmt-merge-msg.adoc
doc: check for absence of the form --[no-]parameter
2025-08-11 14:16:04 -07:00
git-for-each-ref.adoc
Merge branch 'ja/doc-lint-sections-and-synopsis'
2025-08-25 14:22:02 -07:00
git-for-each-repo.adoc
…
git-format-patch.adoc
Merge branch 'js/doc-sending-patch-via-thunderbird'
2025-09-02 08:21:26 -07:00
git-fsck-objects.adoc
…
git-fsck.adoc
doc: check for absence of the form --[no-]parameter
2025-08-11 14:16:04 -07:00
git-fsmonitor--daemon.adoc
…
git-gc.adoc
doc: check for absence of the form --[no-]parameter
2025-08-11 14:16:04 -07:00
git-get-tar-commit-id.adoc
…
git-grep.adoc
…
git-gui.adoc
…
git-hash-object.adoc
…
git-help.adoc
…
git-hook.adoc
…
git-http-backend.adoc
Merge branch 'ps/doc-http-upload-archive-service'
2025-02-14 17:53:49 -08:00
git-http-fetch.adoc
doc: check for absence of multiple terms in each entry of desc list
2025-08-11 14:16:04 -07:00
git-http-push.adoc
…
git-imap-send.adoc
docs: explain how to use git imap-send --list command to get a list of available folders
2025-07-22 08:49:15 -07:00
git-index-pack.adoc
doc: check for absence of the form --[no-]parameter
2025-08-11 14:16:04 -07:00
git-init-db.adoc
…
git-init.adoc
breaking-changes: switch default branch to main
2025-09-10 13:34:58 -07:00
git-instaweb.adoc
…
git-interpret-trailers.adoc
doc: interpret-trailers: convert to synopsis style
2026-03-16 15:04:37 -07:00
git-last-modified.adoc
last-modified: new subcommand to show when files were last modified
2025-08-28 16:44:58 -07:00
git-log.adoc
doc: check for absence of the form --[no-]parameter
2025-08-11 14:16:04 -07:00
git-ls-files.adoc
…
git-ls-remote.adoc
…
git-ls-tree.adoc
…
git-mailinfo.adoc
…
git-mailsplit.adoc
…
git-maintenance.adoc
maintenance: add 'is-needed' subcommand
2025-11-10 09:28:48 -08:00
git-merge-base.adoc
…
git-merge-file.adoc
…
git-merge-index.adoc
…
git-merge-one-file.adoc
…
git-merge-tree.adoc
Merge branch 'en/doc-merge-tree-describe-merge-base'
2025-10-10 12:51:46 -07:00
git-merge.adoc
Merge branch 'ts/merge-orig-head-doc-fix'
2025-07-14 11:19:28 -07:00
git-mergetool--lib.adoc
…
git-mergetool.adoc
doc: convert git-mergetool manpage to new synopsis style
2025-05-27 07:51:01 -07:00
git-mktag.adoc
…
git-mktree.adoc
…
git-multi-pack-index.adoc
Merge branch 'kh/doc-markup-fixes' into maint-2.51
2025-10-15 10:29:33 -07:00
git-mv.adoc
doc: convert git-mv to new documentation format
2025-04-14 14:43:52 -07:00
git-name-rev.adoc
…
git-notes.adoc
doc: notes: use stuck form throughout
2025-05-27 15:31:08 -07:00
git-p4.adoc
doc: check well-formedness of delimited sections
2025-08-11 14:16:03 -07:00
git-pack-objects.adoc
doc: check for absence of the form --[no-]parameter
2025-08-11 14:16:04 -07:00
git-pack-redundant.adoc
…
git-pack-refs.adoc
doc: pack-refs: factor out common options
2025-09-19 10:02:56 -07:00
git-patch-id.adoc
doc: patch-id: --verbatim locks in --stable
2026-01-09 06:08:37 -08:00
git-prune-packed.adoc
…
git-prune.adoc
…
git-pull.adoc
Merge branch 'je/doc-pull'
2025-12-14 17:04:37 +09:00
git-push.adoc
doc: convert git push to synopsis style
2025-11-19 15:00:45 -08:00
git-quiltimport.adoc
…
git-range-diff.adoc
doc: check for absence of the form --[no-]parameter
2025-08-11 14:16:04 -07:00
git-read-tree.adoc
doc: check for absence of the form --[no-]parameter
2025-08-11 14:16:04 -07:00
git-rebase.adoc
Merge branch 'ja/doc-misc-fixes'
2025-12-28 17:36:16 +09:00
git-receive-pack.adoc
builtin/receive-pack: add option to skip connectivity check
2025-05-20 11:43:36 -07:00
git-reflog.adoc
builtin/reflog: implement subcommand to write new entries
2025-08-06 07:36:30 -07:00
git-refs.adoc
Merge branch 'ms/refs-optimize'
2025-10-02 12:26:12 -07:00
git-remote-ext.adoc
…
git-remote-fd.adoc
…
git-remote-helpers.adoco
…
git-remote.adoc
doc: convert git-remote to synopsis style
2025-12-21 11:33:10 +09:00
git-repack.adoc
doc: correct minor wording issues
2025-12-20 14:55:43 +09:00
git-replace.adoc
…
git-replay.adoc
replay: drop rev-list formatting options from manual
2026-01-20 09:38:56 -08:00
git-repo.adoc
Merge branch 'jt/repo-struct-more-objinfo'
2025-12-30 12:58:19 +09:00
git-request-pull.adoc
…
git-rerere.adoc
…
git-reset.adoc
doc: git-reset: clarify git reset <pathspec>
2026-01-06 08:10:14 +09:00
git-restore.adoc
Merge branch 'lm/add-p-context'
2025-08-04 08:10:33 -07:00
git-rev-list.adoc
…
git-rev-parse.adoc
Merge branch 'bc/sha1-256-interop-01'
2025-10-22 11:38:58 -07:00
git-revert.adoc
…
git-rm.adoc
doc: convert git-rm to new documentation format
2025-04-14 14:43:52 -07:00
git-send-email.adoc
Merge branch 'ja/doc-misc-fixes'
2025-12-28 17:36:16 +09:00
git-send-pack.adoc
doc: check for absence of the form --[no-]parameter
2025-08-11 14:16:04 -07:00
git-sh-i18n--envsubst.adoc
…
git-sh-i18n.adoc
…
git-sh-setup.adoc
…
git-shell.adoc
…
git-shortlog.adoc
doc: fix accidental literal blocks
2025-10-10 07:56:09 -07:00
git-show-branch.adoc
…
git-show-index.adoc
Merge branch 'bc/doc-adoc-not-txt'
2025-02-14 17:53:47 -08:00
git-show-ref.adoc
…
git-show.adoc
…
git-sparse-checkout.adoc
Merge branch 'ds/sparse-checkout-clean'
2025-10-28 10:29:09 -07:00
git-stage.adoc
doc: convert git stage to use synopsis block
2025-12-21 11:33:10 +09:00
git-stash.adoc
doc: convert git-stash.adoc to synopis style
2025-10-05 16:09:03 -07:00
git-status.adoc
doc: convert git-status tables to AsciiDoc format
2025-12-21 11:33:10 +09:00
git-stripspace.adoc
doc: stripspace: mention where the default comes from
2025-05-27 15:31:05 -07:00
git-submodule.adoc
Merge branch 'ja/doc-lint-sections-and-synopsis'
2025-08-25 14:22:02 -07:00
git-svn.adoc
doc: check well-formedness of delimited sections
2025-08-11 14:16:03 -07:00
git-switch.adoc
builtin: unmark git-switch and git-restore as experimental
2025-07-28 14:24:03 -07:00
git-symbolic-ref.adoc
…
git-tag.adoc
Merge branch 'cc/fast-import-strip-signed-tags'
2025-10-28 10:29:09 -07:00
git-tools.adoc
…
git-unpack-file.adoc
…
git-unpack-objects.adoc
…
git-update-index.adoc
doc: check for absence of the form --[no-]parameter
2025-08-11 14:16:04 -07:00
git-update-ref.adoc
Merge branch 'sb/doc-update-ref-markup-fix'
2026-01-23 13:34:35 -08:00
git-update-server-info.adoc
…
git-upload-archive.adoc
…
git-upload-pack.adoc
doc: check for absence of the form --[no-]parameter
2025-08-11 14:16:04 -07:00
git-var.adoc
git-var doc: fix usage of $ENV_VAR vs ENV_VAR
2025-05-12 09:25:27 -07:00
git-verify-commit.adoc
git-verify-* doc: update mark-up of synopsis option descriptions
2025-05-12 09:25:27 -07:00
git-verify-pack.adoc
git-verify-* doc: update mark-up of synopsis option descriptions
2025-05-12 09:25:27 -07:00
git-verify-tag.adoc
git-verify-* doc: update mark-up of synopsis option descriptions
2025-05-12 09:25:27 -07:00
git-version.adoc
help: include unsafe SHA-1 build info in version
2025-04-07 14:39:27 -07:00
git-web--browse.adoc
…
git-whatchanged.adoc
whatchanged: remove not-even-shorter clause
2025-09-17 13:47:24 -07:00
git-worktree.adoc
doc: fix asciidoc markup issues in several files
2025-12-20 14:55:43 +09:00
git-write-tree.adoc
git-{var,write-tree} docs: update mark-up of synopsis option descriptions
2025-05-12 09:25:26 -07:00
git.adoc
Merge branch 'js/progress-delay-fix' into maint-2.51
2025-10-14 13:40:54 -07:00
gitattributes.adoc
doc: add a blank line around block delimiters
2025-03-10 09:58:06 -07:00
gitcli.adoc
doc: clarify command equivalence comment
2025-11-04 09:25:51 -08:00
gitcore-tutorial.adoc
…
gitcredentials.adoc
Merge branch 'mh/doc-credential-url-prefix' into maint-2.51
2025-10-15 10:29:35 -07:00
gitcvs-migration.adoc
…
gitdatamodel.adoc
doc: remove stray text in Git data model
2025-12-03 00:17:07 -08:00
gitdiffcore.adoc
…
giteveryday.adoc
…
gitfaq.adoc
Merge branch 'bc/doc-stash-import-export'
2026-01-16 12:40:27 -08:00
gitformat-bundle.adoc
…
gitformat-chunk.adoc
…
gitformat-commit-graph.adoc
…
gitformat-index.adoc
…
gitformat-loose.adoc
docs: add documentation for loose objects
2025-10-09 17:46:14 -07:00
gitformat-pack.adoc
docs: improve ambiguous areas of pack format documentation
2025-10-09 17:46:14 -07:00
gitformat-signature.adoc
…
gitglossary.adoc
…
githooks.adoc
doc: join default pre-commit paragraphs
2025-12-08 22:20:14 +09:00
gitignore.adoc
doc: document backslash in gitignore patterns
2025-10-29 09:17:21 -07:00
gitk.adoc
Merge branch 'js/doc-gitk-history' into maint-2.51
2025-10-14 13:40:53 -07:00
gitmailmap.adoc
…
gitmodules.adoc
…
gitnamespaces.adoc
…
gitpacking.adoc
…
gitprotocol-capabilities.adoc
…
gitprotocol-common.adoc
doc: add a blank line around block delimiters
2025-03-10 09:58:06 -07:00
gitprotocol-http.adoc
doc: clarify server behavior for invalid 'want' lines in HTTP protocol
2025-11-06 09:45:38 -08:00
gitprotocol-pack.adoc
…
gitprotocol-v2.adoc
promisor-remote: allow a server to advertise more fields
2025-09-08 10:30:54 -07:00
gitremote-helpers.adoc
Merge branch 'bs/remote-helpers-doc-markup-fix'
2025-07-14 11:19:22 -07:00
gitrepository-layout.adoc
docs: fix repository-layout when building with breaking changes
2025-03-05 07:25:11 -08:00
gitrevisions.adoc
…
gitsubmodules.adoc
doc: check well-formedness of delimited sections
2025-08-11 14:16:03 -07:00
gittutorial-2.adoc
…
gittutorial.adoc
…
gitweb.adoc
doc: add a blank line around block delimiters
2025-03-10 09:58:06 -07:00
gitweb.conf.adoc
doc: test linkgit macros for well-formedness
2025-08-11 14:16:03 -07:00
gitworkflows.adoc
…
glossary-content.adoc
doc: add an explanation of Git's data model
2025-11-12 12:21:15 -08:00
i18n.adoc
Merge branch 'bc/doc-adoc-not-txt'
2025-02-14 17:53:47 -08:00
install-doc-quick.sh
…
install-webdoc.sh
…
line-range-format.adoc
doc: git-log: convert line range format to new doc format
2025-07-07 13:45:00 -07:00
line-range-options.adoc
doc: git-log: convert line range options to new doc format
2025-07-07 13:45:00 -07:00
lint-delimited-sections.perl
doc: check well-formedness of delimited sections
2025-08-11 14:16:03 -07:00
lint-documentation-style.perl
doc lint: check that synopsis manpages have synopsis inlines
2025-08-11 14:16:04 -07:00
lint-fsck-msgids.perl
…
lint-gitlink.perl
lint-gitlink: preemptively ignore all /ifn?def|endif/ macros
2026-01-21 08:26:00 -08:00
lint-man-end-blurb.perl
…
lint-man-section-order.perl
…
lint-manpages.sh
…
Makefile
Merge branch 'en/xdiff-cleanup-2'
2025-12-05 14:49:56 +09:00
manpage-bold-literal.xsl
…
manpage-normal.xsl
…
manpage.xsl
…
merge-options.adoc
doc: convert git pull to synopsis style
2025-11-19 15:00:42 -08:00
merge-strategies.adoc
doc: convert merge strategies to synopsis format
2025-05-27 07:51:00 -07:00
meson.build
Merge branch 'je/doc-data-model'
2025-11-30 18:31:40 -08:00
MyFirstContribution.adoc
MyFirstContribution: add note on confirming patches
2025-10-27 09:09:53 -07:00
MyFirstObjectWalk.adoc
Merge branch 'jc/you-still-use-whatchanged'
2025-06-25 14:07:35 -07:00
object-format-disclaimer.adoc
…
pack-refs-options.adoc
doc: pack-refs: factor out common options
2025-09-19 10:02:56 -07:00
pretty-formats.adoc
Merge branch 'ja/doc-markup-attached-paragraph-fix' into maint-2.51
2025-10-15 10:29:35 -07:00
pretty-options.adoc
doc: do not break sentences into "lego" pieces
2025-10-05 16:10:53 -07:00
pull-fetch-param.adoc
doc: pull-fetch-param typofix
2025-11-24 10:55:48 -08:00
ref-reachability-filters.adoc
…
ref-storage-format.adoc
…
rerere-options.adoc
doc: convert merge options to new synopsis format
2025-05-27 07:50:59 -07:00
rev-list-description.adoc
doc: git-log convert rev-list-description to new doc format
2025-07-07 13:45:00 -07:00
rev-list-options.adoc
replay: drop rev-list formatting options from manual
2026-01-20 09:38:56 -08:00
ReviewingGuidelines.adoc
…
revisions.adoc
…
scalar.adoc
scalar: document config settings
2025-12-16 09:42:44 +09:00
sequencer.adoc
…
signoff-option.adoc
signoff-option: linkify the reference to gitfaq
2025-12-19 21:51:01 +09:00
SubmittingPatches
Merge branch 'cc/doc-submitting-patches-with-ai'
2025-11-04 07:48:06 -08:00
texi.xsl
…
ToolsForGit.adoc
doc: add a blank line around block delimiters
2025-03-10 09:58:06 -07:00
trace2-target-values.adoc
…
transfer-data-leaks.adoc
…
urls-remotes.adoc
doc: convert git pull to synopsis style
2025-11-19 15:00:42 -08:00
urls.adoc
…
user-manual.adoc
config: drop git_config() wrapper
2025-07-23 08:15:18 -07:00