Skip to content

Commit

Permalink
Merge branch 'hw/doc-in-header' into pu
Browse files Browse the repository at this point in the history
* 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
  ...
  • Loading branch information
gitster committed Nov 12, 2019
2 parents 3a5192d + 387a35a commit 5798950
Show file tree
Hide file tree
Showing 55 changed files with 2,275 additions and 2,846 deletions.
11 changes: 3 additions & 8 deletions Documentation/Makefile
Expand Up @@ -73,7 +73,7 @@ SP_ARTICLES += howto/rebuild-from-update-hook
SP_ARTICLES += howto/rebase-from-internal-branch
SP_ARTICLES += howto/keep-canonical-history-correct
SP_ARTICLES += howto/maintain-git
API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
API_DOCS = $(patsubst %.txt,%,$(wildcard technical/api-*.txt))
SP_ARTICLES += $(API_DOCS)

TECH_DOCS += MyFirstContribution
Expand All @@ -97,7 +97,6 @@ TECH_DOCS += technical/shallow
TECH_DOCS += technical/signature-format
TECH_DOCS += technical/trivial-merge
SP_ARTICLES += $(TECH_DOCS)
SP_ARTICLES += technical/api-index

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

technical/api-index.txt: technical/api-index-skel.txt \
technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
$(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh

technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt \
$(patsubst %,%.html,$(API_DOCS) $(TECH_DOCS)): %.html : %.txt \
asciidoc.conf GIT-ASCIIDOCFLAGS
$(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt

Expand Down
2 changes: 1 addition & 1 deletion Documentation/MyFirstContribution.txt
Expand Up @@ -504,7 +504,7 @@ Try and run `./bin-wrappers/git psuh -h`. Your command should crash at the end.
That's because `-h` is a special case which your command should handle by
printing usage.

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

Expand Down
7 changes: 3 additions & 4 deletions Documentation/MyFirstObjectWalk.txt
Expand Up @@ -17,7 +17,7 @@ revision walk is used for operations like `git log`.

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

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

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

Per entry, we find:

Expand Down
3 changes: 1 addition & 2 deletions Documentation/git-credential.txt
Expand Up @@ -19,8 +19,7 @@ from system-specific helpers, as well as prompting the user for
usernames and passwords. The git-credential command exposes this
interface to scripts which may want to retrieve, store, or prompt for
credentials in the same manner as Git. The design of this scriptable
interface models the internal C API; see
link:technical/api-credentials.html[the Git credential API] for more
interface models the internal C API; see credential.h for more
background on the concepts.

git-credential takes an "action" option on the command-line (one of
Expand Down
3 changes: 0 additions & 3 deletions Documentation/git.txt
Expand Up @@ -904,9 +904,6 @@ See linkgit:gitworkflows[7] for an overview of recommended workflows.
See also the link:howto-index.html[howto] documents for some useful
examples.

The internals are documented in the
link:technical/api-index.html[Git API documentation].

Users migrating from CVS may also want to
read linkgit:gitcvs-migration[7].

Expand Down
3 changes: 1 addition & 2 deletions Documentation/gitcredentials.txt
Expand Up @@ -186,8 +186,7 @@ CUSTOM HELPERS
--------------

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

GIT
---
Expand Down
1 change: 0 additions & 1 deletion Documentation/technical/.gitignore

This file was deleted.

39 changes: 0 additions & 39 deletions Documentation/technical/api-allocation-growing.txt

This file was deleted.

65 changes: 0 additions & 65 deletions Documentation/technical/api-argv-array.txt

This file was deleted.

0 comments on commit 5798950

Please sign in to comment.