Skip to content

Commit 1d7946e

Browse files
committed
Merge branch 'hw/doc-in-header' into pu
* hw/doc-in-header: (21 commits) api-index: remove api doc index files trace2: move doc to trace2.h submodule-config: move doc to submodule-config.h tree-walk: move doc to tree-walk.h trace: move doc to trace.h run-command: move doc to run-command.h parse-options: move doc to parse-options.h credential: move doc to credential.h argv-array: move doc to argv-array.h cache: move doc to cache.h sigchain: move doc to sigchain.h pathspec: move doc to pathspec.h revision: move doc to revision.h attr: move doc to attr.h refs: move doc to refs.h remote: move doc to remote.h and refspec.h sha1-array: move doc to sha1-array.h merge: move doc to ll-merge.h graph: move doc to graph.h and graph.c dir: move doc to dir.h ...
2 parents ec141d6 + 387a35a commit 1d7946e

Some content is hidden

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

54 files changed

+2275
-2780
lines changed

Documentation/Makefile

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ SP_ARTICLES += howto/rebuild-from-update-hook
7373
SP_ARTICLES += howto/rebase-from-internal-branch
7474
SP_ARTICLES += howto/keep-canonical-history-correct
7575
SP_ARTICLES += howto/maintain-git
76-
API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
76+
API_DOCS = $(patsubst %.txt,%,$(wildcard technical/api-*.txt))
7777
SP_ARTICLES += $(API_DOCS)
7878

7979
TECH_DOCS += MyFirstContribution
@@ -97,7 +97,6 @@ TECH_DOCS += technical/shallow
9797
TECH_DOCS += technical/signature-format
9898
TECH_DOCS += technical/trivial-merge
9999
SP_ARTICLES += $(TECH_DOCS)
100-
SP_ARTICLES += technical/api-index
101100

102101
ARTICLES_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
103102
HTML_FILTER ?= $(ARTICLES_HTML) $(OBSOLETE_HTML)
@@ -353,7 +352,7 @@ clean:
353352
$(RM) *.texi *.texi+ *.texi++ git.info gitman.info
354353
$(RM) *.pdf
355354
$(RM) howto-index.txt howto/*.html doc.dep
356-
$(RM) technical/*.html technical/api-index.txt
355+
$(RM) technical/*.html
357356
$(RM) SubmittingPatches.txt
358357
$(RM) $(cmds_txt) $(mergetools_txt) *.made
359358
$(RM) manpage-base-url.xsl
@@ -386,12 +385,8 @@ user-manual.xml: user-manual.txt user-manual.conf asciidoctor-extensions.rb GIT-
386385
$(TXT_TO_XML) -d book -o $@+ $< && \
387386
mv $@+ $@
388387

389-
technical/api-index.txt: technical/api-index-skel.txt \
390-
technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
391-
$(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh
392-
393388
technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
394-
$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt \
389+
$(patsubst %,%.html,$(API_DOCS) $(TECH_DOCS)): %.html : %.txt \
395390
asciidoc.conf GIT-ASCIIDOCFLAGS
396391
$(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt
397392

Documentation/MyFirstContribution.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,7 @@ Try and run `./bin-wrappers/git psuh -h`. Your command should crash at the end.
504504
That's because `-h` is a special case which your command should handle by
505505
printing usage.
506506

507-
Take a look at `Documentation/technical/api-parse-options.txt`. This is a handy
507+
Take a look at `parse-options.h`. This is a handy
508508
tool for pulling out options you need to be able to handle, and it takes a
509509
usage string.
510510

Documentation/MyFirstObjectWalk.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ revision walk is used for operations like `git log`.
1717

1818
- `Documentation/user-manual.txt` under "Hacking Git" contains some coverage of
1919
the revision walker in its various incarnations.
20-
- `Documentation/technical/api-revision-walking.txt`
20+
- `revision.h`
2121
- https://eagain.net/articles/git-for-computer-scientists/[Git for Computer Scientists]
2222
gives a good overview of the types of objects in Git and what your object
2323
walk is really describing.
@@ -119,9 +119,8 @@ parameters provided by the user over the CLI.
119119

120120
`nr` represents the number of `rev_cmdline_entry` present in the array.
121121

122-
`alloc` is used by the `ALLOC_GROW` macro. Check
123-
`Documentation/technical/api-allocation-growing.txt` - this variable is used to
124-
track the allocated size of the list.
122+
`alloc` is used by the `ALLOC_GROW` macro. Check `cache.h` - this variable is
123+
used to track the allocated size of the list.
125124

126125
Per entry, we find:
127126

Documentation/git-credential.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@ from system-specific helpers, as well as prompting the user for
1919
usernames and passwords. The git-credential command exposes this
2020
interface to scripts which may want to retrieve, store, or prompt for
2121
credentials in the same manner as Git. The design of this scriptable
22-
interface models the internal C API; see
23-
link:technical/api-credentials.html[the Git credential API] for more
22+
interface models the internal C API; see credential.h for more
2423
background on the concepts.
2524

2625
git-credential takes an "action" option on the command-line (one of

Documentation/git.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -904,9 +904,6 @@ See linkgit:gitworkflows[7] for an overview of recommended workflows.
904904
See also the link:howto-index.html[howto] documents for some useful
905905
examples.
906906

907-
The internals are documented in the
908-
link:technical/api-index.html[Git API documentation].
909-
910907
Users migrating from CVS may also want to
911908
read linkgit:gitcvs-migration[7].
912909

Documentation/gitcredentials.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,7 @@ CUSTOM HELPERS
186186
--------------
187187

188188
You can write your own custom helpers to interface with any system in
189-
which you keep credentials. See the documentation for Git's
190-
link:technical/api-credentials.html[credentials API] for details.
189+
which you keep credentials. See credential.h for details.
191190

192191
GIT
193192
---

Documentation/technical/.gitignore

Lines changed: 0 additions & 1 deletion
This file was deleted.

Documentation/technical/api-allocation-growing.txt

Lines changed: 0 additions & 39 deletions
This file was deleted.

Documentation/technical/api-argv-array.txt

Lines changed: 0 additions & 65 deletions
This file was deleted.

0 commit comments

Comments
 (0)