Permalink
Browse files

Documentation: use [verse] for SYNOPSIS sections

The SYNOPSIS sections of most commands that span several lines already
use [verse] to retain line breaks. Most commands that don't span
several lines seem not to use [verse]. In the HTML output, [verse]
does not only preserve line breaks, but also makes the section
indented, which causes a slight inconsistency between commands that
use [verse] and those that don't. Use [verse] in all SYNOPSIS sections
for consistency.

Also remove the blank lines from git-fetch.txt and git-rebase.txt to
align with the other man pages. In the case of git-rebase.txt, which
already uses [verse], the blank line makes the [verse] not apply to
the last line, so removing the blank line also makes the formatting
within the document more consistent.

While at it, add single quotes to 'git cvsimport' for consistency with
other commands.

Signed-off-by: Martin von Zweigbergk <martin.von.zweigbergk@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information...
1 parent f696543 commit 7791a1d9b9a4f4e15662c7c9c7f5837f461bb987 Martin von Zweigbergk committed with gitster Jul 2, 2011
Showing with 92 additions and 6 deletions.
  1. +1 −0 Documentation/git-annotate.txt
  2. +1 −0 Documentation/git-bisect.txt
  3. +1 −0 Documentation/git-cherry-pick.txt
  4. +1 −0 Documentation/git-cherry.txt
  5. +1 −0 Documentation/git-citool.txt
  6. +1 −0 Documentation/git-commit-tree.txt
  7. +1 −0 Documentation/git-count-objects.txt
  8. +1 −0 Documentation/git-cvsexportcommit.txt
  9. +1 −0 Documentation/git-diff-files.txt
  10. +1 −0 Documentation/git-diff-index.txt
  11. +1 −0 Documentation/git-difftool.txt
  12. +1 −0 Documentation/git-fast-export.txt
  13. +1 −0 Documentation/git-fast-import.txt
  14. +1 −0 Documentation/git-fetch-pack.txt
  15. +1 −3 Documentation/git-fetch.txt
  16. +1 −0 Documentation/git-fsck-objects.txt
  17. +1 −0 Documentation/git-gc.txt
  18. +1 −0 Documentation/git-get-tar-commit-id.txt
  19. +1 −0 Documentation/git-gui.txt
  20. +1 −0 Documentation/git-help.txt
  21. +1 −0 Documentation/git-http-fetch.txt
  22. +1 −0 Documentation/git-http-push.txt
  23. +1 −0 Documentation/git-imap-send.txt
  24. +1 −0 Documentation/git-init-db.txt
  25. +1 −0 Documentation/git-init.txt
  26. +1 −0 Documentation/git-log.txt
  27. +1 −0 Documentation/git-lost-found.txt
  28. +1 −0 Documentation/git-mailinfo.txt
  29. +1 −0 Documentation/git-mailsplit.txt
  30. +1 −0 Documentation/git-merge-index.txt
  31. +1 −0 Documentation/git-merge-one-file.txt
  32. +1 −0 Documentation/git-merge-tree.txt
  33. +1 −0 Documentation/git-mergetool--lib.txt
  34. +1 −0 Documentation/git-mergetool.txt
  35. +1 −0 Documentation/git-mktag.txt
  36. +1 −0 Documentation/git-mktree.txt
  37. +1 −0 Documentation/git-mv.txt
  38. +1 −0 Documentation/git-pack-redundant.txt
  39. +1 −0 Documentation/git-pack-refs.txt
  40. +1 −0 Documentation/git-parse-remote.txt
  41. +1 −0 Documentation/git-patch-id.txt
  42. +1 −0 Documentation/git-peek-remote.txt
  43. +1 −0 Documentation/git-prune-packed.txt
  44. +1 −0 Documentation/git-prune.txt
  45. +1 −0 Documentation/git-pull.txt
  46. +1 −0 Documentation/git-read-tree.txt
  47. +0 −1 Documentation/git-rebase.txt
  48. +1 −0 Documentation/git-receive-pack.txt
  49. +1 −0 Documentation/git-reflog.txt
  50. +1 −0 Documentation/git-relink.txt
  51. +1 −0 Documentation/git-remote-ext.txt
  52. +1 −0 Documentation/git-remote-helpers.txt
  53. +1 −0 Documentation/git-repack.txt
  54. +1 −0 Documentation/git-repo-config.txt
  55. +1 −0 Documentation/git-request-pull.txt
  56. +1 −0 Documentation/git-rerere.txt
  57. +1 −0 Documentation/git-rev-parse.txt
  58. +1 −0 Documentation/git-revert.txt
  59. +1 −0 Documentation/git-rm.txt
  60. +1 −0 Documentation/git-send-email.txt
  61. +1 −0 Documentation/git-send-pack.txt
  62. +1 −0 Documentation/git-sh-i18n.txt
  63. +1 −0 Documentation/git-sh-setup.txt
  64. +1 −0 Documentation/git-shell.txt
  65. +0 −1 Documentation/git-show-branch.txt
  66. +1 −0 Documentation/git-show-index.txt
  67. +1 −0 Documentation/git-show.txt
  68. +1 −0 Documentation/git-status.txt
  69. +1 −0 Documentation/git-stripspace.txt
  70. +1 −0 Documentation/git-svn.txt
  71. +1 −0 Documentation/git-symbolic-ref.txt
  72. +1 −0 Documentation/git-tar-tree.txt
  73. +1 −0 Documentation/git-unpack-file.txt
  74. +1 −0 Documentation/git-unpack-objects.txt
  75. +1 −0 Documentation/git-update-ref.txt
  76. +1 −0 Documentation/git-update-server-info.txt
  77. +1 −0 Documentation/git-upload-archive.txt
  78. +1 −0 Documentation/git-upload-pack.txt
  79. +1 −0 Documentation/git-var.txt
  80. +1 −0 Documentation/git-verify-pack.txt
  81. +1 −0 Documentation/git-verify-tag.txt
  82. +1 −0 Documentation/git-web--browse.txt
  83. +1 −0 Documentation/git-whatchanged.txt
  84. +1 −0 Documentation/git-write-tree.txt
  85. +2 −1 Documentation/gitcvs-migration.txt
  86. +1 −0 Documentation/gitdiffcore.txt
  87. +1 −0 Documentation/gitk.txt
  88. +1 −0 Documentation/gittutorial-2.txt
  89. +1 −0 Documentation/gittutorial.txt
  90. +1 −0 Documentation/gitworkflows.txt
  91. +1 −0 contrib/convert-objects/git-convert-objects.txt
  92. +1 −0 contrib/gitview/gitview.txt
  93. +1 −0 contrib/svn-fe/svn-fe.txt
@@ -7,6 +7,7 @@ git-annotate - Annotate file lines with commit information
SYNOPSIS
--------
+[verse]
'git annotate' [options] file [revision]
DESCRIPTION
@@ -8,6 +8,7 @@ git-bisect - Find by binary search the change that introduced a bug
SYNOPSIS
--------
+[verse]
'git bisect' <subcommand> <options>
DESCRIPTION
@@ -7,6 +7,7 @@ git-cherry-pick - Apply the changes introduced by some existing commits
SYNOPSIS
--------
+[verse]
'git cherry-pick' [--edit] [-n] [-m parent-number] [-s] [-x] [--ff] <commit>...
DESCRIPTION
@@ -7,6 +7,7 @@ git-cherry - Find commits not merged upstream
SYNOPSIS
--------
+[verse]
'git cherry' [-v] [<upstream> [<head> [<limit>]]]
DESCRIPTION
@@ -7,6 +7,7 @@ git-citool - Graphical alternative to git-commit
SYNOPSIS
--------
+[verse]
'git citool'
DESCRIPTION
@@ -8,6 +8,7 @@ git-commit-tree - Create a new commit object
SYNOPSIS
--------
+[verse]
'git commit-tree' <tree> [(-p <parent commit>)...] < changelog
DESCRIPTION
@@ -7,6 +7,7 @@ git-count-objects - Count unpacked number of objects and their disk consumption
SYNOPSIS
--------
+[verse]
'git count-objects' [-v]
DESCRIPTION
@@ -8,6 +8,7 @@ git-cvsexportcommit - Export a single commit to a CVS checkout
SYNOPSIS
--------
+[verse]
'git cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d cvsroot]
[-w cvsworkdir] [-W] [-f] [-m msgprefix] [PARENTCOMMIT] COMMITID
@@ -8,6 +8,7 @@ git-diff-files - Compares files in the working tree and the index
SYNOPSIS
--------
+[verse]
'git diff-files' [-q] [-0|-1|-2|-3|-c|--cc] [<common diff options>] [<path>...]
DESCRIPTION
@@ -8,6 +8,7 @@ git-diff-index - Compares content and mode of blobs between the index and reposi
SYNOPSIS
--------
+[verse]
'git diff-index' [-m] [--cached] [<common diff options>] <tree-ish> [<path>...]
DESCRIPTION
@@ -7,6 +7,7 @@ git-difftool - Show changes using common diff tools
SYNOPSIS
--------
+[verse]
'git difftool' [<options>] [<commit> [<commit>]] [--] [<path>...]
DESCRIPTION
@@ -8,6 +8,7 @@ git-fast-export - Git data exporter
SYNOPSIS
--------
+[verse]
'git fast-export [options]' | 'git fast-import'
DESCRIPTION
@@ -8,6 +8,7 @@ git-fast-import - Backend for fast Git data importers
SYNOPSIS
--------
+[verse]
frontend | 'git fast-import' [options]
DESCRIPTION
@@ -8,6 +8,7 @@ git-fetch-pack - Receive missing objects from another repository
SYNOPSIS
--------
+[verse]
'git fetch-pack' [--all] [--quiet|-q] [--keep|-k] [--thin] [--include-tag] [--upload-pack=<git-upload-pack>] [--depth=<n>] [--no-progress] [-v] [<host>:]<directory> [<refs>...]
DESCRIPTION
@@ -8,12 +8,10 @@ git-fetch - Download objects and refs from another repository
SYNOPSIS
--------
+[verse]
'git fetch' [<options>] [<repository> [<refspec>...]]
-
'git fetch' [<options>] <group>
-
'git fetch' --multiple [<options>] [(<repository> | <group>)...]
-
'git fetch' --all [<options>]
@@ -8,6 +8,7 @@ git-fsck-objects - Verifies the connectivity and validity of the objects in the
SYNOPSIS
--------
+[verse]
'git fsck-objects' ...
DESCRIPTION
View
@@ -8,6 +8,7 @@ git-gc - Cleanup unnecessary files and optimize the local repository
SYNOPSIS
--------
+[verse]
'git gc' [--aggressive] [--auto] [--quiet] [--prune=<date> | --no-prune]
DESCRIPTION
@@ -8,6 +8,7 @@ git-get-tar-commit-id - Extract commit ID from an archive created using git-arch
SYNOPSIS
--------
+[verse]
'git get-tar-commit-id' < <tarfile>
@@ -7,6 +7,7 @@ git-gui - A portable graphical interface to Git
SYNOPSIS
--------
+[verse]
'git gui' [<command>] [arguments]
DESCRIPTION
@@ -7,6 +7,7 @@ git-help - display help information about git
SYNOPSIS
--------
+[verse]
'git help' [-a|--all|-i|--info|-m|--man|-w|--web] [COMMAND]
DESCRIPTION
@@ -8,6 +8,7 @@ git-http-fetch - Download from a remote git repository via HTTP
SYNOPSIS
--------
+[verse]
'git http-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] [--stdin] <commit> <url>
DESCRIPTION
@@ -8,6 +8,7 @@ git-http-push - Push objects over HTTP/DAV to another repository
SYNOPSIS
--------
+[verse]
'git http-push' [--all] [--dry-run] [--force] [--verbose] <url> <ref> [<ref>...]
DESCRIPTION
@@ -8,6 +8,7 @@ git-imap-send - Send a collection of patches from stdin to an IMAP folder
SYNOPSIS
--------
+[verse]
'git imap-send'
@@ -8,6 +8,7 @@ git-init-db - Creates an empty git repository
SYNOPSIS
--------
+[verse]
'git init-db' [-q | --quiet] [--bare] [--template=<template_directory>] [--separate-git-dir <git dir>] [--shared[=<permissions>]]
@@ -8,6 +8,7 @@ git-init - Create an empty git repository or reinitialize an existing one
SYNOPSIS
--------
+[verse]
'git init' [-q | --quiet] [--bare] [--template=<template_directory>]
[--separate-git-dir <git dir>]
[--shared[=<permissions>]] [directory]
@@ -8,6 +8,7 @@ git-log - Show commit logs
SYNOPSIS
--------
+[verse]
'git log' [<options>] [<since>..<until>] [[\--] <path>...]
DESCRIPTION
@@ -7,6 +7,7 @@ git-lost-found - Recover lost refs that luckily have not yet been pruned
SYNOPSIS
--------
+[verse]
'git lost-found'
DESCRIPTION
@@ -8,6 +8,7 @@ git-mailinfo - Extracts patch and authorship from a single e-mail message
SYNOPSIS
--------
+[verse]
'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n] [--scissors] <msg> <patch>
@@ -7,6 +7,7 @@ git-mailsplit - Simple UNIX mbox splitter program
SYNOPSIS
--------
+[verse]
'git mailsplit' [-b] [-f<nn>] [-d<prec>] [--keep-cr] -o<directory> [--] [(<mbox>|<Maildir>)...]
DESCRIPTION
@@ -8,6 +8,7 @@ git-merge-index - Run a merge for files needing merging
SYNOPSIS
--------
+[verse]
'git merge-index' [-o] [-q] <merge-program> (-a | [--] <file>*)
DESCRIPTION
@@ -8,6 +8,7 @@ git-merge-one-file - The standard helper program to use with git-merge-index
SYNOPSIS
--------
+[verse]
'git merge-one-file'
DESCRIPTION
@@ -8,6 +8,7 @@ git-merge-tree - Show three-way merge without touching index
SYNOPSIS
--------
+[verse]
'git merge-tree' <base-tree> <branch1> <branch2>
DESCRIPTION
@@ -7,6 +7,7 @@ git-mergetool--lib - Common git merge tool shell scriptlets
SYNOPSIS
--------
+[verse]
'TOOL_MODE=(diff|merge) . "$(git --exec-path)/git-mergetool--lib"'
DESCRIPTION
@@ -7,6 +7,7 @@ git-mergetool - Run merge conflict resolution tools to resolve merge conflicts
SYNOPSIS
--------
+[verse]
'git mergetool' [--tool=<tool>] [-y|--no-prompt|--prompt] [<file>...]
DESCRIPTION
@@ -8,6 +8,7 @@ git-mktag - Creates a tag object
SYNOPSIS
--------
+[verse]
'git mktag' < signature_file
DESCRIPTION
@@ -8,6 +8,7 @@ git-mktree - Build a tree-object from ls-tree formatted text
SYNOPSIS
--------
+[verse]
'git mktree' [-z] [--missing] [--batch]
DESCRIPTION
View
@@ -8,6 +8,7 @@ git-mv - Move or rename a file, a directory, or a symlink
SYNOPSIS
--------
+[verse]
'git mv' <options>... <args>...
DESCRIPTION
@@ -8,6 +8,7 @@ git-pack-redundant - Find redundant pack files
SYNOPSIS
--------
+[verse]
'git pack-redundant' [ --verbose ] [ --alt-odb ] < --all | .pack filename ... >
DESCRIPTION
@@ -7,6 +7,7 @@ git-pack-refs - Pack heads and tags for efficient repository access
SYNOPSIS
--------
+[verse]
'git pack-refs' [--all] [--no-prune]
DESCRIPTION
@@ -8,6 +8,7 @@ git-parse-remote - Routines to help parsing remote repository access parameters
SYNOPSIS
--------
+[verse]
'. "$(git --exec-path)/git-parse-remote"'
DESCRIPTION
@@ -7,6 +7,7 @@ git-patch-id - Compute unique ID for a patch
SYNOPSIS
--------
+[verse]
'git patch-id' < <patch>
DESCRIPTION
@@ -8,6 +8,7 @@ git-peek-remote - List the references in a remote repository
SYNOPSIS
--------
+[verse]
'git peek-remote' [--upload-pack=<git-upload-pack>] [<host>:]<directory>
DESCRIPTION
@@ -8,6 +8,7 @@ git-prune-packed - Remove extra objects that are already in pack files
SYNOPSIS
--------
+[verse]
'git prune-packed' [-n|--dry-run] [-q|--quiet]
@@ -8,6 +8,7 @@ git-prune - Prune all unreachable objects from the object database
SYNOPSIS
--------
+[verse]
'git prune' [-n] [-v] [--expire <expire>] [--] [<head>...]
DESCRIPTION
@@ -8,6 +8,7 @@ git-pull - Fetch from and merge with another repository or a local branch
SYNOPSIS
--------
+[verse]
'git pull' [options] [<repository> [<refspec>...]]
@@ -8,6 +8,7 @@ git-read-tree - Reads tree information into the index
SYNOPSIS
--------
+[verse]
'git read-tree' [[-m [--trivial] [--aggressive] | --reset | --prefix=<prefix>]
[-u [--exclude-per-directory=<gitignore>] | -i]]
[--index-output=<file>] [--no-sparse-checkout]
@@ -12,7 +12,6 @@ SYNOPSIS
[<upstream>] [<branch>]
'git rebase' [-i | --interactive] [options] --onto <newbase>
--root [<branch>]
-
'git rebase' --continue | --skip | --abort
DESCRIPTION
@@ -8,6 +8,7 @@ git-receive-pack - Receive what is pushed into the repository
SYNOPSIS
--------
+[verse]
'git-receive-pack' <directory>
DESCRIPTION
@@ -8,6 +8,7 @@ git-reflog - Manage reflog information
SYNOPSIS
--------
+[verse]
'git reflog' <subcommand> <options>
DESCRIPTION
Oops, something went wrong.

0 comments on commit 7791a1d

Please sign in to comment.