Skip to content

Commit

Permalink
Merge branch 'hw/doc-in-header'
Browse files Browse the repository at this point in the history
* hw/doc-in-header:
  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: add link to doc file in 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
  diff: move doc to diff.h and diffcore.h
  • Loading branch information
gitster committed Dec 16, 2019
2 parents f0070a7 + 6c51cb5 commit 26c816a
Show file tree
Hide file tree
Showing 48 changed files with 1,931 additions and 2,452 deletions.
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: 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
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 26c816a

Please sign in to comment.