File Manager

X7ROOT File Manager

Current Path: /usr/share/doc/git-1.8.3.1/technical

usr / share / doc / git-1.8.3.1 / technical /

📁 ..
📄 api-allocation-growing.html(17.55 KB)
📄 api-allocation-growing.txt(1019 B)
📄 api-argv-array.html(19.44 KB)
📄 api-argv-array.txt(2.12 KB)
📄 api-builtin.html(19.43 KB)
📄 api-builtin.txt(2 KB)
📄 api-config.html(23.39 KB)
📄 api-config.txt(5.18 KB)
📄 api-credentials.html(27.9 KB)
📄 api-credentials.txt(8.87 KB)
📄 api-decorate.html(16.23 KB)
📄 api-decorate.txt(60 B)
📄 api-diff.html(24.32 KB)
📄 api-diff.txt(5.22 KB)
📄 api-directory-listing.html(20.75 KB)
📄 api-directory-listing.txt(2.71 KB)
📄 api-gitattributes.html(21.9 KB)
📄 api-gitattributes.txt(3.62 KB)
📄 api-grep.html(16.31 KB)
📄 api-grep.txt(76 B)
📄 api-hash.html(18.42 KB)
📄 api-hash.txt(1.4 KB)
📄 api-hashmap.html(35.57 KB)
📄 api-hashmap.txt(7.71 KB)
📄 api-history-graph.html(24.08 KB)
📄 api-history-graph.txt(5.9 KB)
📄 api-in-core-index.html(16.96 KB)
📄 api-in-core-index.txt(457 B)
📄 api-index-skel.txt(431 B)
📄 api-index.html(18.45 KB)
📄 api-index.sh(611 B)
📄 api-index.txt(1.68 KB)
📄 api-lockfile.html(20.05 KB)
📄 api-lockfile.txt(2.92 KB)
📄 api-merge.html(21.36 KB)
📄 api-merge.txt(3.3 KB)
📄 api-object-access.html(16.73 KB)
📄 api-object-access.txt(342 B)
📄 api-parse-options.html(31.03 KB)
📄 api-parse-options.txt(9.36 KB)
📄 api-quote.html(16.42 KB)
📄 api-quote.txt(145 B)
📄 api-ref-iteration.html(19.71 KB)
📄 api-ref-iteration.txt(2.41 KB)
📄 api-remote.html(21.26 KB)
📄 api-remote.txt(3.3 KB)
📄 api-revision-walking.html(19.76 KB)
📄 api-revision-walking.txt(2.39 KB)
📄 api-run-command.html(28.25 KB)
📄 api-run-command.txt(8.08 KB)
📄 api-setup.html(16.51 KB)
📄 api-setup.txt(180 B)
📄 api-sha1-array.html(19.39 KB)
📄 api-sha1-array.txt(2.25 KB)
📄 api-sigchain.html(17.74 KB)
📄 api-sigchain.txt(1.34 KB)
📄 api-strbuf.html(32.15 KB)
📄 api-strbuf.txt(10.17 KB)
📄 api-string-list.html(26.42 KB)
📄 api-string-list.txt(6.84 KB)
📄 api-tree-walking.html(23.17 KB)
📄 api-tree-walking.txt(4.27 KB)
📄 api-xdiff-interface.html(16.3 KB)
📄 api-xdiff-interface.txt(139 B)
📄 index-format.html(27.12 KB)
📄 index-format.txt(6.29 KB)
📄 pack-format.html(24.08 KB)
📄 pack-format.txt(5.54 KB)
📄 pack-heuristics.html(42.74 KB)
📄 pack-heuristics.txt(17.77 KB)
📄 pack-protocol.html(43.12 KB)
📄 pack-protocol.txt(20.99 KB)
📄 protocol-capabilities.html(25.41 KB)
📄 protocol-capabilities.txt(7.09 KB)
📄 protocol-common.html(20.08 KB)
📄 protocol-common.txt(2.7 KB)
📄 racy-git.html(26.85 KB)
📄 racy-git.txt(8.63 KB)
📄 send-pack-pipeline.html(18.73 KB)
📄 send-pack-pipeline.txt(1.92 KB)
📄 shallow.html(18.86 KB)
📄 shallow.txt(2.3 KB)
📄 trivial-merge.html(21.62 KB)
📄 trivial-merge.txt(4.16 KB)

Editing: api-directory-listing.txt

directory listing API
=====================

The directory listing API is used to enumerate paths in the work tree,
optionally taking `.git/info/exclude` and `.gitignore` files per
directory into account.

Data structure
--------------

`struct dir_struct` structure is used to pass directory traversal
options to the library and to record the paths discovered.  A single
`struct dir_struct` is used regardless of whether or not the traversal
recursively descends into subdirectories.

The notable options are:

`exclude_per_dir`::

The name of the file to be read in each directory for excluded
	files (typically `.gitignore`).

`flags`::

A bit-field of options (the `*IGNORED*` flags are mutually exclusive):

`DIR_SHOW_IGNORED`:::

Return just ignored files in `entries[]`, not untracked files.

`DIR_SHOW_IGNORED_TOO`:::

Similar to `DIR_SHOW_IGNORED`, but return ignored files in `ignored[]`
	in addition to untracked files in `entries[]`.

`DIR_COLLECT_IGNORED`:::

Special mode for git-add. Return ignored files in `ignored[]` and
	untracked files in `entries[]`. Only returns ignored files that match
	pathspec exactly (no wildcards). Does not recurse into ignored
	directories.

`DIR_SHOW_OTHER_DIRECTORIES`:::

Include a directory that is not tracked.

`DIR_HIDE_EMPTY_DIRECTORIES`:::

Do not include a directory that is not tracked and is empty.

`DIR_NO_GITLINKS`:::

If set, recurse into a directory that looks like a Git
	directory.  Otherwise it is shown as a directory.

The result of the enumeration is left in these fields:

`entries[]`::

An array of `struct dir_entry`, each element of which describes
	a path.

`nr`::

The number of members in `entries[]` array.

`alloc`::

Internal use; keeps track of allocation of `entries[]` array.

`ignored[]`::

An array of `struct dir_entry`, used for ignored paths with the
	`DIR_SHOW_IGNORED_TOO` and `DIR_COLLECT_IGNORED` flags.

`ignored_nr`::

The number of members in `ignored[]` array.

Calling sequence
----------------

Note: index may be looked at for .gitignore files that are CE_SKIP_WORKTREE
marked. If you to exclude files, make sure you have loaded index first.

* Prepare `struct dir_struct dir` and clear it with `memset(&dir, 0,
  sizeof(dir))`.

* To add single exclude pattern, call `add_exclude_list()` and then
  `add_exclude()`.

* To add patterns from a file (e.g. `.git/info/exclude`), call
  `add_excludes_from_file()` , and/or set `dir.exclude_per_dir`.  A
  short-hand function `setup_standard_excludes()` can be used to set
  up the standard set of exclude settings.

* Set options described in the Data Structure section above.

* Call `read_directory()`.

* Use `dir.entries[]`.

* Call `clear_directory()` when none of the contained elements are no longer in use.

(JC)

X7ROOT File Manager

Editing: api-directory-listing.txt

Upload File

Create Folder