Permalink
Browse files

Merge branch 'ta/doc-no-small-caps'

Update documentation to change "GIT" which was a poor-man's small
caps to "Git".  The latter was the intended spelling.

Also change "git" spelled in all-lowercase to "Git" when it refers
to the system as the whole or the concept it embodies, as opposed to
the command the end users would type.

* ta/doc-no-small-caps:
  Documentation: StGit is the right spelling, not StGIT
  Documentation: describe the "repository" in repository-layout
  Documentation: add a description for 'gitfile' to glossary
  Documentation: do not use undefined terms git-dir and git-file
  Documentation: the name of the system is 'Git', not 'git'
  Documentation: avoid poor-man's small caps GIT
  • Loading branch information...
2 parents 6d81ce0 + afeef30 commit e34c7e2b51c02a761a034b877b852dc0dbccf101 @gitster committed Feb 6, 2013
Showing with 982 additions and 959 deletions.
  1. +12 −7 Documentation/CodingGuidelines
  2. +2 −2 Documentation/Makefile
  3. +6 −6 Documentation/SubmittingPatches
  4. +1 −1 Documentation/asciidoc.conf
  5. +2 −2 Documentation/blame-options.txt
  6. +56 −56 Documentation/config.txt
  7. +1 −1 Documentation/diff-config.txt
  8. +2 −2 Documentation/diff-options.txt
  9. +5 −5 Documentation/everyday.txt
  10. +2 −2 Documentation/git-apply.txt
  11. +8 −8 Documentation/git-archimport.txt
  12. +1 −1 Documentation/git-archive.txt
  13. +11 −11 Documentation/git-bisect-lk2009.txt
  14. +2 −2 Documentation/git-bisect.txt
  15. +1 −1 Documentation/git-blame.txt
  16. +1 −1 Documentation/git-branch.txt
  17. +1 −1 Documentation/git-bundle.txt
  18. +2 −2 Documentation/git-check-ref-format.txt
  19. +2 −2 Documentation/git-checkout.txt
  20. +4 −4 Documentation/git-clean.txt
  21. +8 −8 Documentation/git-clone.txt
  22. +1 −1 Documentation/git-commit-tree.txt
  23. +3 −3 Documentation/git-commit.txt
  24. +2 −2 Documentation/git-credential-cache.txt
  25. +3 −3 Documentation/git-credential-store.txt
  26. +3 −3 Documentation/git-credential.txt
  27. +3 −3 Documentation/git-cvsexportcommit.txt
  28. +5 −5 Documentation/git-cvsimport.txt
  29. +14 −14 Documentation/git-cvsserver.txt
  30. +6 −6 Documentation/git-daemon.txt
  31. +1 −1 Documentation/git-describe.txt
  32. +1 −1 Documentation/git-diff.txt
  33. +1 −1 Documentation/git-difftool.txt
  34. +1 −1 Documentation/git-fetch.txt
  35. +3 −3 Documentation/git-filter-branch.txt
  36. +5 −5 Documentation/git-format-patch.txt
  37. +3 −3 Documentation/git-fsck.txt
  38. +1 −1 Documentation/git-grep.txt
  39. +1 −1 Documentation/git-gui.txt
  40. +1 −1 Documentation/git-hash-object.txt
  41. +3 −3 Documentation/git-help.txt
  42. +1 −1 Documentation/git-http-backend.txt
  43. +2 −2 Documentation/git-http-fetch.txt
  44. +3 −3 Documentation/git-index-pack.txt
  45. +1 −1 Documentation/git-init-db.txt
  46. +8 −8 Documentation/git-init.txt
  47. +1 −1 Documentation/git-log.txt
  48. +1 −1 Documentation/git-ls-files.txt
  49. +2 −2 Documentation/git-merge-index.txt
  50. +2 −2 Documentation/git-merge.txt
  51. +2 −2 Documentation/git-mergetool--lib.txt
  52. +2 −2 Documentation/git-mktag.txt
  53. +1 −1 Documentation/git-mv.txt
  54. +42 −42 Documentation/git-p4.txt
  55. +6 −6 Documentation/git-pack-objects.txt
  56. +4 −4 Documentation/git-pull.txt
  57. +4 −4 Documentation/git-push.txt
  58. +2 −2 Documentation/git-quiltimport.txt
  59. +1 −1 Documentation/git-rebase.txt
  60. +1 −1 Documentation/git-reflog.txt
  61. +7 −7 Documentation/git-remote-ext.txt
  62. +4 −4 Documentation/git-remote-fd.txt
  63. +24 −24 Documentation/git-remote-helpers.txt
  64. +1 −1 Documentation/git-replace.txt
  65. +1 −1 Documentation/git-rev-list.txt
  66. +7 −5 Documentation/git-rev-parse.txt
  67. +5 −5 Documentation/git-rm.txt
  68. +1 −1 Documentation/git-send-email.txt
  69. +1 −1 Documentation/git-send-pack.txt
  70. +2 −2 Documentation/git-sh-setup.txt
  71. +1 −1 Documentation/git-show-index.txt
  72. +4 −4 Documentation/git-status.txt
  73. +1 −1 Documentation/git-stripspace.txt
  74. +1 −1 Documentation/git-submodule.txt
  75. +44 −44 Documentation/git-svn.txt
  76. +1 −1 Documentation/git-tag.txt
  77. +22 −22 Documentation/git-tools.txt
  78. +8 −8 Documentation/git-update-index.txt
  79. +1 −1 Documentation/git-update-ref.txt
  80. +1 −1 Documentation/git-upload-archive.txt
  81. +1 −1 Documentation/git-upload-pack.txt
  82. +6 −6 Documentation/git-var.txt
  83. +2 −2 Documentation/git-verify-pack.txt
  84. +1 −1 Documentation/git-verify-tag.txt
  85. +2 −2 Documentation/git-web--browse.txt
  86. +2 −2 Documentation/git-whatchanged.txt
  87. +45 −45 Documentation/git.txt
  88. +36 −36 Documentation/gitattributes.txt
  89. +7 −7 Documentation/gitcli.txt
  90. +77 −77 Documentation/gitcore-tutorial.txt
  91. +12 −12 Documentation/gitcredentials.txt
  92. +11 −11 Documentation/gitcvs-migration.txt
  93. +1 −1 Documentation/gitdiffcore.txt
  94. +2 −2 Documentation/gitglossary.txt
  95. +4 −4 Documentation/githooks.txt
  96. +11 −11 Documentation/gitignore.txt
  97. +4 −4 Documentation/gitk.txt
  98. +2 −2 Documentation/gitmodules.txt
  99. +1 −1 Documentation/gitnamespaces.txt
  100. +21 −9 Documentation/gitrepository-layout.txt
  101. +1 −1 Documentation/gitrevisions.txt
  102. +19 −19 Documentation/gittutorial-2.txt
  103. +23 −23 Documentation/gittutorial.txt
  104. +16 −16 Documentation/gitweb.conf.txt
  105. +11 −11 Documentation/gitweb.txt
  106. +3 −3 Documentation/gitworkflows.txt
  107. +33 −29 Documentation/glossary-content.txt
  108. +2 −2 Documentation/howto-index.sh
  109. +3 −3 Documentation/howto/maintain-git.txt
  110. +10 −10 Documentation/howto/new-command.txt
  111. +3 −3 Documentation/howto/rebase-from-internal-branch.txt
  112. +4 −4 Documentation/howto/rebuild-from-update-hook.txt
  113. +2 −2 Documentation/howto/recover-corrupted-blob-object.txt
  114. +1 −1 Documentation/howto/revert-a-faulty-merge.txt
  115. +2 −2 Documentation/howto/revert-branch-rebase.txt
  116. +9 −9 Documentation/howto/setup-git-server-over-http.txt
  117. +1 −1 Documentation/howto/use-git-daemon.txt
  118. +2 −2 Documentation/howto/using-signed-tag-in-pull-request.txt
  119. +4 −4 Documentation/i18n.txt
  120. +4 −4 Documentation/merge-config.txt
  121. +2 −2 Documentation/rev-list-options.txt
  122. +1 −1 Documentation/revisions.txt
  123. +2 −2 Documentation/technical/api-builtin.txt
  124. +5 −5 Documentation/technical/api-config.txt
  125. +10 −10 Documentation/technical/api-credentials.txt
  126. +1 −1 Documentation/technical/api-directory-listing.txt
  127. +2 −2 Documentation/technical/api-index-skel.txt
  128. +1 −1 Documentation/technical/api-parse-options.txt
  129. +2 −2 Documentation/technical/api-remote.txt
  130. +4 −4 Documentation/technical/index-format.txt
  131. +2 −2 Documentation/technical/pack-format.txt
  132. +10 −10 Documentation/technical/pack-heuristics.txt
  133. +13 −13 Documentation/technical/racy-git.txt
  134. +1 −1 Documentation/urls-remotes.txt
  135. +2 −2 Documentation/urls.txt
  136. +108 −108 Documentation/user-manual.txt
  137. +1 −1 README
@@ -1,5 +1,5 @@
Like other projects, we also have some guidelines to keep to the
-code. For git in general, three rough rules are:
+code. For Git in general, three rough rules are:
- Most importantly, we never say "It's in POSIX; we'll happily
ignore your needs should your system not conform to it."
@@ -22,7 +22,7 @@ code. For git in general, three rough rules are:
As for more concrete guidelines, just imitate the existing code
(this is a good guideline, no matter which project you are
contributing to). It is always preferable to match the _local_
-convention. New code added to git suite is expected to match
+convention. New code added to Git suite is expected to match
the overall style of existing code. Modifications to existing
code is expected to match the style the surrounding code already
uses (even if it doesn't match the overall style of existing code).
@@ -112,7 +112,7 @@ For C programs:
- We try to keep to at most 80 characters per line.
- - We try to support a wide range of C compilers to compile git with,
+ - We try to support a wide range of C compilers to compile Git with,
including old ones. That means that you should not use C99
initializers, even if a lot of compilers grok it.
@@ -164,14 +164,14 @@ For C programs:
- If you are planning a new command, consider writing it in shell
or perl first, so that changes in semantics can be easily
- changed and discussed. Many git commands started out like
+ changed and discussed. Many Git commands started out like
that, and a few are still scripts.
- - Avoid introducing a new dependency into git. This means you
+ - Avoid introducing a new dependency into Git. This means you
usually should stay away from scripting languages not already
- used in the git core command set (unless your command is clearly
+ used in the Git core command set (unless your command is clearly
separate from it, such as an importer to convert random-scm-X
- repositories to git).
+ repositories to Git).
- When we pass <string, length> pair to functions, we should try to
pass them in that order.
@@ -230,3 +230,8 @@ Writing Documentation:
valid usage. "*" has its own pair of brackets, because it can
(optionally) be specified only when one or more of the letters is
also provided.
+
+ A note on notation:
+ Use 'git' (all lowercase) when talking about commands i.e. something
+ the user would type into a shell and use 'Git' (uppercase first letter)
+ when talking about the version control system and its properties.
View
@@ -346,8 +346,8 @@ $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
install-webdoc : html
'$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
-# You must have a clone of git-htmldocs and git-manpages repositories
-# next to the git repository itself for the following to work.
+# You must have a clone of 'git-htmldocs' and 'git-manpages' repositories
+# next to the 'git' repository itself for the following to work.
quick-install: quick-install-man
@@ -103,9 +103,9 @@ without external resources. Instead of giving a URL to a mailing list
archive, summarize the relevant points of the discussion.
-(3) Generate your patch using git tools out of your commits.
+(3) Generate your patch using Git tools out of your commits.
-git based diff tools generate unidiff which is the preferred format.
+Git based diff tools generate unidiff which is the preferred format.
You do not have to be afraid to use -M option to "git diff" or
"git format-patch", if your patch involves file renames. The
@@ -122,7 +122,7 @@ that is fine, but please mark it as such.
(4) Sending your patches.
-People on the git mailing list need to be able to read and
+People on the Git mailing list need to be able to read and
comment on the changes you are submitting. It is important for
a developer to be able to "quote" your changes, using standard
e-mail tools, so that they may comment on specific portions of
@@ -206,7 +206,7 @@ patch.
To improve tracking of who did what, we've borrowed the
"sign-off" procedure from the Linux kernel project on patches
-that are being emailed around. Although core GIT is a lot
+that are being emailed around. Although core Git is a lot
smaller project it is a good discipline to follow it.
The sign-off is a simple line at the end of the explanation for
@@ -244,7 +244,7 @@ then you just add a line saying
Signed-off-by: Random J Developer <random@developer.example.org>
-This line can be automatically added by git if you run the git-commit
+This line can be automatically added by Git if you run the git-commit
command with the -s option.
Notice that you can place your own Signed-off-by: line when
@@ -337,7 +337,7 @@ Know the status of your patch after submission
tell you if your patch is merged in pu if you rebase on top of
master).
-* Read the git mailing list, the maintainer regularly posts messages
+* Read the Git mailing list, the maintainer regularly posts messages
entitled "What's cooking in git.git" and "What's in git.git" giving
the status of various proposed changes.
@@ -4,7 +4,7 @@
#
# Note, {0} is the manpage section, while {target} is the command.
#
-# Show GIT link as: <command>(<section>); if section is defined, else just show
+# Show Git link as: <command>(<section>); if section is defined, else just show
# the command.
[macros]
@@ -95,7 +95,7 @@ of lines before or after the line given by <start>.
running extra passes of inspection.
+
<num> is optional but it is the lower bound on the number of
-alphanumeric characters that git must detect as moving/copying
+alphanumeric characters that Git must detect as moving/copying
within a file for it to associate those lines with the parent
commit. The default value is 20.
@@ -110,7 +110,7 @@ commit. The default value is 20.
looks for copies from other files in any commit.
+
<num> is optional but it is the lower bound on the number of
-alphanumeric characters that git must detect as moving/copying
+alphanumeric characters that Git must detect as moving/copying
between files for it to associate those lines with the parent
commit. And the default value is 40. If there are more than one
`-C` options given, the <num> argument of the last `-C` will
Oops, something went wrong.

0 comments on commit e34c7e2

Please sign in to comment.