Skip to content

Commit 5a357fa

Browse files
gitstergitster
committed
Merge branch 'ab/doc-lint'
Dev support. * ab/doc-lint: docs: fix linting issues due to incorrect relative section order doc lint: lint relative section order doc lint: lint and fix missing "GIT" end sections doc lint: fix bugs in, simplify and improve lint script doc lint: Perl "strict" and "warnings" in lint-gitlink.perl Documentation/Makefile: make doc.dep dependencies a variable again Documentation/Makefile: make $(wildcard howto/*.txt) a var
2 parents fe069dc + 414abf1 commit 5a357fa

File tree

12 files changed

+288
-138
lines changed

12 files changed

+288
-138
lines changed

‎Documentation/Makefile‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
MAN1_TXT =
33
MAN5_TXT =
44
MAN7_TXT =
5+
HOWTO_TXT =
6+
DOC_DEP_TXT =
57
TECH_DOCS =
68
ARTICLES =
79
SP_ARTICLES =
@@ -42,6 +44,11 @@ MAN7_TXT += gittutorial-2.txt
4244
MAN7_TXT += gittutorial.txt
4345
MAN7_TXT += gitworkflows.txt
4446

47+
HOWTO_TXT += $(wildcard howto/*.txt)
48+
49+
DOC_DEP_TXT += $(wildcard *.txt)
50+
DOC_DEP_TXT += $(wildcard config/*.txt)
51+
4552
ifdef MAN_FILTER
4653
MAN_TXT = $(filter $(MAN_FILTER),$(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT))
4754
else
@@ -286,7 +293,7 @@ docdep_prereqs = \
286293
mergetools-list.made $(mergetools_txt) \
287294
cmd-list.made $(cmds_txt)
288295

289-
doc.dep : $(docdep_prereqs) $(wildcard *.txt) $(wildcard config/*.txt) build-docdep.perl
296+
doc.dep : $(docdep_prereqs) $(DOC_DEP_TXT) build-docdep.perl
290297
$(QUIET_GEN)$(RM) $@+ $@ && \
291298
$(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
292299
mv $@+ $@
@@ -429,9 +436,9 @@ $(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
429436
$(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
430437
mv $@+ $@
431438

432-
howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
439+
howto-index.txt: howto-index.sh $(HOWTO_TXT)
433440
$(QUIET_GEN)$(RM) $@+ $@ && \
434-
'$(SHELL_PATH_SQ)' ./howto-index.sh $(sort $(wildcard howto/*.txt)) >$@+ && \
441+
'$(SHELL_PATH_SQ)' ./howto-index.sh $(sort $(HOWTO_TXT)) >$@+ && \
435442
mv $@+ $@
436443

437444
$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
@@ -440,7 +447,7 @@ $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
440447
WEBDOC_DEST = /pub/software/scm/git/docs
441448

442449
howto/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
443-
$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt GIT-ASCIIDOCFLAGS
450+
$(patsubst %.txt,%.html,$(HOWTO_TXT)): %.html : %.txt GIT-ASCIIDOCFLAGS
444451
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
445452
sed -e '1,/^$$/d' $< | \
446453
$(TXT_TO_HTML) - >$@+ && \
@@ -472,7 +479,13 @@ print-man1:
472479
@for i in $(MAN1_TXT); do echo $$i; done
473480

474481
lint-docs::
475-
$(QUIET_LINT)$(PERL_PATH) lint-gitlink.perl
482+
$(QUIET_LINT)$(PERL_PATH) lint-gitlink.perl \
483+
$(HOWTO_TXT) $(DOC_DEP_TXT) \
484+
--section=1 $(MAN1_TXT) \
485+
--section=5 $(MAN5_TXT) \
486+
--section=7 $(MAN7_TXT); \
487+
$(PERL_PATH) lint-man-end-blurb.perl $(MAN_TXT); \
488+
$(PERL_PATH) lint-man-section-order.perl $(MAN_TXT);
476489

477490
ifeq ($(wildcard po/Makefile),po/Makefile)
478491
doc-l10n install-l10n::

‎Documentation/git-credential.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,3 +159,7 @@ empty string.
159159
+
160160
Components which are missing from the URL (e.g., there is no
161161
username in the example above) will be left unset.
162+
163+
GIT
164+
---
165+
Part of the linkgit:git[1] suite

‎Documentation/git-cvsserver.txt‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,18 @@ Usage:
2424
[verse]
2525
'git-cvsserver' [<options>] [pserver|server] [<directory> ...]
2626

27+
DESCRIPTION
28+
-----------
29+
30+
This application is a CVS emulation layer for Git.
31+
32+
It is highly functional. However, not all methods are implemented,
33+
and for those methods that are implemented,
34+
not all switches are implemented.
35+
36+
Testing has been done using both the CLI CVS client, and the Eclipse CVS
37+
plugin. Most functionality works fine with both of these clients.
38+
2739
OPTIONS
2840
-------
2941

@@ -57,18 +69,6 @@ access still needs to be enabled by the `gitcvs.enabled` config option
5769
unless `--export-all` was given, too.
5870

5971

60-
DESCRIPTION
61-
-----------
62-
63-
This application is a CVS emulation layer for Git.
64-
65-
It is highly functional. However, not all methods are implemented,
66-
and for those methods that are implemented,
67-
not all switches are implemented.
68-
69-
Testing has been done using both the CLI CVS client, and the Eclipse CVS
70-
plugin. Most functionality works fine with both of these clients.
71-
7272
LIMITATIONS
7373
-----------
7474

‎Documentation/git-grep.txt‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -38,38 +38,6 @@ are lists of one or more search expressions separated by newline
3838
characters. An empty string as search expression matches all lines.
3939

4040

41-
CONFIGURATION
42-
-------------
43-
44-
grep.lineNumber::
45-
If set to true, enable `-n` option by default.
46-
47-
grep.column::
48-
If set to true, enable the `--column` option by default.
49-
50-
grep.patternType::
51-
Set the default matching behavior. Using a value of 'basic', 'extended',
52-
'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
53-
`--fixed-strings`, or `--perl-regexp` option accordingly, while the
54-
value 'default' will return to the default matching behavior.
55-
56-
grep.extendedRegexp::
57-
If set to true, enable `--extended-regexp` option by default. This
58-
option is ignored when the `grep.patternType` option is set to a value
59-
other than 'default'.
60-
61-
grep.threads::
62-
Number of grep worker threads to use. If unset (or set to 0), Git will
63-
use as many threads as the number of logical cores available.
64-
65-
grep.fullName::
66-
If set to true, enable `--full-name` option by default.
67-
68-
grep.fallbackToNoIndex::
69-
If set to true, fall back to git grep --no-index if git grep
70-
is executed outside of a git repository. Defaults to false.
71-
72-
7341
OPTIONS
7442
-------
7543
--cached::
@@ -363,6 +331,38 @@ with multiple threads might perform slower than single threaded if `--textconv`
363331
is given and there're too many text conversions. So if you experience low
364332
performance in this case, it might be desirable to use `--threads=1`.
365333

334+
CONFIGURATION
335+
-------------
336+
337+
grep.lineNumber::
338+
If set to true, enable `-n` option by default.
339+
340+
grep.column::
341+
If set to true, enable the `--column` option by default.
342+
343+
grep.patternType::
344+
Set the default matching behavior. Using a value of 'basic', 'extended',
345+
'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
346+
`--fixed-strings`, or `--perl-regexp` option accordingly, while the
347+
value 'default' will return to the default matching behavior.
348+
349+
grep.extendedRegexp::
350+
If set to true, enable `--extended-regexp` option by default. This
351+
option is ignored when the `grep.patternType` option is set to a value
352+
other than 'default'.
353+
354+
grep.threads::
355+
Number of grep worker threads to use. If unset (or set to 0), Git will
356+
use as many threads as the number of logical cores available.
357+
358+
grep.fullName::
359+
If set to true, enable `--full-name` option by default.
360+
361+
grep.fallbackToNoIndex::
362+
If set to true, fall back to git grep --no-index if git grep
363+
is executed outside of a git repository. Defaults to false.
364+
365+
366366
GIT
367367
---
368368
Part of the linkgit:git[1] suite

‎Documentation/git-mktag.txt‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,6 @@ SYNOPSIS
1111
[verse]
1212
'git mktag'
1313

14-
OPTIONS
15-
-------
16-
17-
--strict::
18-
By default mktag turns on the equivalent of
19-
linkgit:git-fsck[1] `--strict` mode. Use `--no-strict` to
20-
disable it.
21-
2214
DESCRIPTION
2315
-----------
2416

@@ -45,6 +37,14 @@ the appropriate `fsck.<msg-id>` varible:
4537

4638
git -c fsck.extraHeaderEntry=ignore mktag <my-tag-with-headers
4739

40+
OPTIONS
41+
-------
42+
43+
--strict::
44+
By default mktag turns on the equivalent of
45+
linkgit:git-fsck[1] `--strict` mode. Use `--no-strict` to
46+
disable it.
47+
4848
Tag Format
4949
----------
5050
A tag signature file, to be fed to this command's standard input,

‎Documentation/git-p4.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -762,3 +762,7 @@ IMPLEMENTATION DETAILS
762762
message indicating the p4 depot location and change number. This
763763
line is used by later 'git p4 sync' operations to know which p4
764764
changes are new.
765+
766+
GIT
767+
---
768+
Part of the linkgit:git[1] suite

‎Documentation/git-rebase.txt‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -200,12 +200,6 @@ Alternatively, you can undo the 'git rebase' with
200200

201201
git rebase --abort
202202

203-
CONFIGURATION
204-
-------------
205-
206-
include::config/rebase.txt[]
207-
include::config/sequencer.txt[]
208-
209203
OPTIONS
210204
-------
211205
--onto <newbase>::
@@ -1266,6 +1260,12 @@ merge tlsv1.3
12661260
merge cmake
12671261
------------
12681262

1263+
CONFIGURATION
1264+
-------------
1265+
1266+
include::config/rebase.txt[]
1267+
include::config/sequencer.txt[]
1268+
12691269
BUGS
12701270
----
12711271
The todo list presented by the deprecated `--preserve-merges --interactive`

‎Documentation/git-svn.txt‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1061,25 +1061,6 @@ with different name spaces. For example:
10611061
branches = stable/*:refs/remotes/svn/stable/*
10621062
branches = debug/*:refs/remotes/svn/debug/*
10631063

1064-
BUGS
1065-
----
1066-
1067-
We ignore all SVN properties except svn:executable. Any unhandled
1068-
properties are logged to $GIT_DIR/svn/<refname>/unhandled.log
1069-
1070-
Renamed and copied directories are not detected by Git and hence not
1071-
tracked when committing to SVN. I do not plan on adding support for
1072-
this as it's quite difficult and time-consuming to get working for all
1073-
the possible corner cases (Git doesn't do it, either). Committing
1074-
renamed and copied files is fully supported if they're similar enough
1075-
for Git to detect them.
1076-
1077-
In SVN, it is possible (though discouraged) to commit changes to a tag
1078-
(because a tag is just a directory copy, thus technically the same as a
1079-
branch). When cloning an SVN repository, 'git svn' cannot know if such a
1080-
commit to a tag will happen in the future. Thus it acts conservatively
1081-
and imports all SVN tags as branches, prefixing the tag name with 'tags/'.
1082-
10831064
CONFIGURATION
10841065
-------------
10851066

@@ -1166,6 +1147,25 @@ $GIT_DIR/svn/\**/.rev_map.*::
11661147
if it is missing or not up to date. 'git svn reset' automatically
11671148
rewinds it.
11681149

1150+
BUGS
1151+
----
1152+
1153+
We ignore all SVN properties except svn:executable. Any unhandled
1154+
properties are logged to $GIT_DIR/svn/<refname>/unhandled.log
1155+
1156+
Renamed and copied directories are not detected by Git and hence not
1157+
tracked when committing to SVN. I do not plan on adding support for
1158+
this as it's quite difficult and time-consuming to get working for all
1159+
the possible corner cases (Git doesn't do it, either). Committing
1160+
renamed and copied files is fully supported if they're similar enough
1161+
for Git to detect them.
1162+
1163+
In SVN, it is possible (though discouraged) to commit changes to a tag
1164+
(because a tag is just a directory copy, thus technically the same as a
1165+
branch). When cloning an SVN repository, 'git svn' cannot know if such a
1166+
commit to a tag will happen in the future. Thus it acts conservatively
1167+
and imports all SVN tags as branches, prefixing the tag name with 'tags/'.
1168+
11691169
SEE ALSO
11701170
--------
11711171
linkgit:git-rebase[1]

‎Documentation/gitnamespaces.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,7 @@ git clone ext::'git --namespace=foo %s /tmp/prefixed.git'
6262
----------
6363

6464
include::transfer-data-leaks.txt[]
65+
66+
GIT
67+
---
68+
Part of the linkgit:git[1] suite

0 commit comments

Comments
 (0)