Skip to content

Commit 76a8788

Browse files
pcloudsgitster
authored andcommitted
doc: keep first level section header in upper case
When formatted as a man page, 1st section header is always in upper case even if we write it otherwise. Make all 1st section headers uppercase to keep it close to the final output. This does affect html since case is kept there, but I still think it's a good idea to maintain a consistent style for 1st section headers. Some sections perhaps should become second sections instead, where case is kept, and for better organization. I will update if anyone has suggestions about this. While at there I also make some header more consistent (e.g. examples vs example) and fix a couple minor things here and there. Signed-off-by: Nguyễn Thái Ngọc Duy <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 1f1cddd commit 76a8788

38 files changed

+96
-96
lines changed

Documentation/git-add.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ for "git add --no-all <pathspec>...", i.e. ignored removed files.
193193
for command-line options).
194194

195195

196-
Configuration
196+
CONFIGURATION
197197
-------------
198198

199199
The optional configuration variable `core.excludesFile` indicates a path to a
@@ -226,7 +226,7 @@ Because this example lets the shell expand the asterisk (i.e. you are
226226
listing the files explicitly), it does not consider
227227
`subdir/git-foo.sh`.
228228

229-
Interactive mode
229+
INTERACTIVE MODE
230230
----------------
231231
When the command enters the interactive mode, it shows the
232232
output of the 'status' subcommand, and then goes into its

Documentation/git-apply.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ When `git apply` is used as a "better GNU patch", the user can pass
240240
the `--unsafe-paths` option to override this safety check. This option
241241
has no effect when `--index` or `--cached` is in use.
242242

243-
Configuration
243+
CONFIGURATION
244244
-------------
245245

246246
apply.ignoreWhitespace::
@@ -251,7 +251,7 @@ apply.whitespace::
251251
When no `--whitespace` flag is given from the command
252252
line, this configuration item is used as the default.
253253

254-
Submodules
254+
SUBMODULES
255255
----------
256256
If the patch contains any changes to submodules then 'git apply'
257257
treats these changes as follows.

Documentation/git-branch.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ CONFIGURATION
287287
`--list` is used or implied. The default is to use a pager.
288288
See linkgit:git-config[1].
289289

290-
Examples
290+
EXAMPLES
291291
--------
292292

293293
Start development from a known tag::
@@ -318,7 +318,7 @@ See linkgit:git-fetch[1].
318318
is currently checked out) does not have all commits from the test branch.
319319

320320

321-
Notes
321+
NOTES
322322
-----
323323

324324
If you are creating a branch that you want to checkout immediately, it is

Documentation/git-bundle.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,8 @@ It is okay to err on the side of caution, causing the bundle file
9292
to contain objects already in the destination, as these are ignored
9393
when unpacking at the destination.
9494

95-
EXAMPLE
96-
-------
95+
EXAMPLES
96+
--------
9797

9898
Assume you want to transfer the history from a repository R1 on machine A
9999
to another repository R2 on machine B.

Documentation/git-clone.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ or `--mirror` is given)
273273
:git-clone: 1
274274
include::urls.txt[]
275275

276-
Examples
276+
EXAMPLES
277277
--------
278278

279279
* Clone from upstream:

Documentation/git-cvsserver.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ allowing access over SSH.
207207
------
208208

209209
[[dbbackend]]
210-
Database Backend
210+
DATABASE BACKEND
211211
----------------
212212

213213
'git-cvsserver' uses one database per Git head (i.e. CVS module) to
@@ -321,7 +321,7 @@ git-cvsserver, as described above.
321321
When these environment variables are set, the corresponding
322322
command-line arguments may not be used.
323323

324-
Eclipse CVS Client Notes
324+
ECLIPSE CVS CLIENT NOTES
325325
------------------------
326326

327327
To get a checkout with the Eclipse CVS client:
@@ -346,15 +346,15 @@ offer. In that case CVS_SERVER is ignored, and you will have to replace
346346
the cvs utility on the server with 'git-cvsserver' or manipulate your `.bashrc`
347347
so that calling 'cvs' effectively calls 'git-cvsserver'.
348348

349-
Clients known to work
349+
CLIENTS KNOWN TO WORK
350350
---------------------
351351

352352
- CVS 1.12.9 on Debian
353353
- CVS 1.11.17 on MacOSX (from Fink package)
354354
- Eclipse 3.0, 3.1.2 on MacOSX (see Eclipse CVS Client Notes)
355355
- TortoiseCVS
356356

357-
Operations supported
357+
OPERATIONS SUPPORTED
358358
--------------------
359359

360360
All the operations required for normal use are supported, including
@@ -424,7 +424,7 @@ For best consistency with 'cvs', it is probably best to override the
424424
defaults by setting `gitcvs.usecrlfattr` to true,
425425
and `gitcvs.allBinary` to "guess".
426426

427-
Dependencies
427+
DEPENDENCIES
428428
------------
429429
'git-cvsserver' depends on DBD::SQLite.
430430

Documentation/git-diff-index.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@ include::diff-options.txt[]
3737

3838
include::diff-format.txt[]
3939

40-
Operating Modes
40+
OPERATING MODES
4141
---------------
4242
You can choose whether you want to trust the index file entirely
4343
(using the `--cached` flag) or ask the diff logic to show any files
4444
that don't match the stat state as being "tentatively changed". Both
4545
of these operations are very useful indeed.
4646

47-
Cached Mode
47+
CACHED MODE
4848
-----------
4949
If `--cached` is specified, it allows you to ask:
5050

@@ -77,7 +77,7 @@ So doing a `git diff-index --cached` is basically very useful when you are
7777
asking yourself "what have I already marked for being committed, and
7878
what's the difference to a previous tree".
7979

80-
Non-cached Mode
80+
NON-CACHED MODE
8181
---------------
8282
The "non-cached" mode takes a different approach, and is potentially
8383
the more useful of the two in that what it does can't be emulated with

Documentation/git-diff-tree.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ include::pretty-options.txt[]
116116
include::pretty-formats.txt[]
117117

118118

119-
Limiting Output
119+
LIMITING OUTPUT
120120
---------------
121121
If you're only interested in differences in a subset of files, for
122122
example some architecture-specific files, you might do:

Documentation/git-fast-export.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ smaller output, and it is usually easy to quickly confirm that there is
202202
no private data in the stream.
203203

204204

205-
Limitations
205+
LIMITATIONS
206206
-----------
207207

208208
Since 'git fast-import' cannot tag trees, you will not be

Documentation/git-fast-import.txt

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ Performance and Compression Tuning
139139
fastimport.unpackLimit::
140140
See linkgit:git-config[1]
141141

142-
Performance
142+
PERFORMANCE
143143
-----------
144144
The design of fast-import allows it to import large projects in a minimum
145145
amount of memory usage and processing time. Assuming the frontend
@@ -155,7 +155,7 @@ faster if the source data is stored on a different drive than the
155155
destination Git repository (due to less IO contention).
156156

157157

158-
Development Cost
158+
DEVELOPMENT COST
159159
----------------
160160
A typical frontend for fast-import tends to weigh in at approximately 200
161161
lines of Perl/Python/Ruby code. Most developers have been able to
@@ -165,7 +165,7 @@ an ideal situation, given that most conversion tools are throw-away
165165
(use once, and never look back).
166166

167167

168-
Parallel Operation
168+
PARALLEL OPERATION
169169
------------------
170170
Like 'git push' or 'git fetch', imports handled by fast-import are safe to
171171
run alongside parallel `git repack -a -d` or `git gc` invocations,
@@ -186,7 +186,7 @@ this only be used on an otherwise quiet repository. Using --force
186186
is not necessary for an initial import into an empty repository.
187187

188188

189-
Technical Discussion
189+
TECHNICAL DISCUSSION
190190
--------------------
191191
fast-import tracks a set of branches in memory. Any branch can be created
192192
or modified at any point during the import process by sending a
@@ -204,7 +204,7 @@ directory also allows fast-import to run very quickly, as it does not
204204
need to perform any costly file update operations when switching
205205
between branches.
206206

207-
Input Format
207+
INPUT FORMAT
208208
------------
209209
With the exception of raw file data (which Git does not interpret)
210210
the fast-import input format is text (ASCII) based. This text based
@@ -1131,7 +1131,7 @@ If the `--done` command-line option or `feature done` command is
11311131
in use, the `done` command is mandatory and marks the end of the
11321132
stream.
11331133

1134-
Responses To Commands
1134+
RESPONSES TO COMMANDS
11351135
---------------------
11361136
New objects written by fast-import are not available immediately.
11371137
Most fast-import commands have no visible effect until the next
@@ -1160,7 +1160,7 @@ To avoid deadlock, such frontends must completely consume any
11601160
pending output from `progress`, `ls`, `get-mark`, and `cat-blob` before
11611161
performing writes to fast-import that might block.
11621162

1163-
Crash Reports
1163+
CRASH REPORTS
11641164
-------------
11651165
If fast-import is supplied invalid input it will terminate with a
11661166
non-zero exit status and create a crash report in the top level of
@@ -1247,7 +1247,7 @@ An example crash:
12471247
END OF CRASH REPORT
12481248
====
12491249

1250-
Tips and Tricks
1250+
TIPS AND TRICKS
12511251
---------------
12521252
The following tips and tricks have been collected from various
12531253
users of fast-import, and are offered here as suggestions.
@@ -1349,7 +1349,7 @@ Your users will feel better knowing how much of the data stream
13491349
has been processed.
13501350

13511351

1352-
Packfile Optimization
1352+
PACKFILE OPTIMIZATION
13531353
---------------------
13541354
When packing a blob fast-import always attempts to deltify against the last
13551355
blob written. Unless specifically arranged for by the frontend,
@@ -1380,7 +1380,7 @@ to force recomputation of all deltas can significantly reduce the
13801380
final packfile size (30-50% smaller can be quite typical).
13811381

13821382

1383-
Memory Utilization
1383+
MEMORY UTILIZATION
13841384
------------------
13851385
There are a number of factors which affect how much memory fast-import
13861386
requires to perform an import. Like critical sections of core
@@ -1458,7 +1458,7 @@ and lazy loading of subtrees, allows fast-import to efficiently import
14581458
projects with 2,000+ branches and 45,114+ files in a very limited
14591459
memory footprint (less than 2.7 MiB per active branch).
14601460

1461-
Signals
1461+
SIGNALS
14621462
-------
14631463
Sending *SIGUSR1* to the 'git fast-import' process ends the current
14641464
packfile early, simulating a `checkpoint` command. The impatient

0 commit comments

Comments
 (0)