Skip to content

Commit e34c7e2

Browse files
gitstergitster
committed
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
2 parents 6d81ce0 + afeef30 commit e34c7e2

File tree

137 files changed

+982
-959
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

137 files changed

+982
-959
lines changed

‎Documentation/CodingGuidelines‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Like other projects, we also have some guidelines to keep to the
2-
code. For git in general, three rough rules are:
2+
code. For Git in general, three rough rules are:
33

44
- Most importantly, we never say "It's in POSIX; we'll happily
55
ignore your needs should your system not conform to it."
@@ -22,7 +22,7 @@ code. For git in general, three rough rules are:
2222
As for more concrete guidelines, just imitate the existing code
2323
(this is a good guideline, no matter which project you are
2424
contributing to). It is always preferable to match the _local_
25-
convention. New code added to git suite is expected to match
25+
convention. New code added to Git suite is expected to match
2626
the overall style of existing code. Modifications to existing
2727
code is expected to match the style the surrounding code already
2828
uses (even if it doesn't match the overall style of existing code).
@@ -112,7 +112,7 @@ For C programs:
112112

113113
- We try to keep to at most 80 characters per line.
114114

115-
- We try to support a wide range of C compilers to compile git with,
115+
- We try to support a wide range of C compilers to compile Git with,
116116
including old ones. That means that you should not use C99
117117
initializers, even if a lot of compilers grok it.
118118

@@ -164,14 +164,14 @@ For C programs:
164164

165165
- If you are planning a new command, consider writing it in shell
166166
or perl first, so that changes in semantics can be easily
167-
changed and discussed. Many git commands started out like
167+
changed and discussed. Many Git commands started out like
168168
that, and a few are still scripts.
169169

170-
- Avoid introducing a new dependency into git. This means you
170+
- Avoid introducing a new dependency into Git. This means you
171171
usually should stay away from scripting languages not already
172-
used in the git core command set (unless your command is clearly
172+
used in the Git core command set (unless your command is clearly
173173
separate from it, such as an importer to convert random-scm-X
174-
repositories to git).
174+
repositories to Git).
175175

176176
- When we pass <string, length> pair to functions, we should try to
177177
pass them in that order.
@@ -230,3 +230,8 @@ Writing Documentation:
230230
valid usage. "*" has its own pair of brackets, because it can
231231
(optionally) be specified only when one or more of the letters is
232232
also provided.
233+
234+
A note on notation:
235+
Use 'git' (all lowercase) when talking about commands i.e. something
236+
the user would type into a shell and use 'Git' (uppercase first letter)
237+
when talking about the version control system and its properties.

‎Documentation/Makefile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -346,8 +346,8 @@ $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
346346
install-webdoc : html
347347
'$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
348348

349-
# You must have a clone of git-htmldocs and git-manpages repositories
350-
# next to the git repository itself for the following to work.
349+
# You must have a clone of 'git-htmldocs' and 'git-manpages' repositories
350+
# next to the 'git' repository itself for the following to work.
351351

352352
quick-install: quick-install-man
353353

‎Documentation/SubmittingPatches‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,9 @@ without external resources. Instead of giving a URL to a mailing list
103103
archive, summarize the relevant points of the discussion.
104104

105105

106-
(3) Generate your patch using git tools out of your commits.
106+
(3) Generate your patch using Git tools out of your commits.
107107

108-
git based diff tools generate unidiff which is the preferred format.
108+
Git based diff tools generate unidiff which is the preferred format.
109109

110110
You do not have to be afraid to use -M option to "git diff" or
111111
"git format-patch", if your patch involves file renames. The
@@ -122,7 +122,7 @@ that is fine, but please mark it as such.
122122

123123
(4) Sending your patches.
124124

125-
People on the git mailing list need to be able to read and
125+
People on the Git mailing list need to be able to read and
126126
comment on the changes you are submitting. It is important for
127127
a developer to be able to "quote" your changes, using standard
128128
e-mail tools, so that they may comment on specific portions of
@@ -206,7 +206,7 @@ patch.
206206

207207
To improve tracking of who did what, we've borrowed the
208208
"sign-off" procedure from the Linux kernel project on patches
209-
that are being emailed around. Although core GIT is a lot
209+
that are being emailed around. Although core Git is a lot
210210
smaller project it is a good discipline to follow it.
211211

212212
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
244244

245245
Signed-off-by: Random J Developer <random@developer.example.org>
246246

247-
This line can be automatically added by git if you run the git-commit
247+
This line can be automatically added by Git if you run the git-commit
248248
command with the -s option.
249249

250250
Notice that you can place your own Signed-off-by: line when
@@ -337,7 +337,7 @@ Know the status of your patch after submission
337337
tell you if your patch is merged in pu if you rebase on top of
338338
master).
339339

340-
* Read the git mailing list, the maintainer regularly posts messages
340+
* Read the Git mailing list, the maintainer regularly posts messages
341341
entitled "What's cooking in git.git" and "What's in git.git" giving
342342
the status of various proposed changes.
343343

‎Documentation/asciidoc.conf‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#
55
# Note, {0} is the manpage section, while {target} is the command.
66
#
7-
# Show GIT link as: <command>(<section>); if section is defined, else just show
7+
# Show Git link as: <command>(<section>); if section is defined, else just show
88
# the command.
99

1010
[macros]

‎Documentation/blame-options.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ of lines before or after the line given by <start>.
9595
running extra passes of inspection.
9696
+
9797
<num> is optional but it is the lower bound on the number of
98-
alphanumeric characters that git must detect as moving/copying
98+
alphanumeric characters that Git must detect as moving/copying
9999
within a file for it to associate those lines with the parent
100100
commit. The default value is 20.
101101

@@ -110,7 +110,7 @@ commit. The default value is 20.
110110
looks for copies from other files in any commit.
111111
+
112112
<num> is optional but it is the lower bound on the number of
113-
alphanumeric characters that git must detect as moving/copying
113+
alphanumeric characters that Git must detect as moving/copying
114114
between files for it to associate those lines with the parent
115115
commit. And the default value is 40. If there are more than one
116116
`-C` options given, the <num> argument of the last `-C` will

0 commit comments

Comments
 (0)