Stefan Beller 830c912a0e documentation: retire unfinished documentation ... When looking for documentation for a specific function, you may be tempted to run git -C Documentation grep index_name_pos only to find the file technical/api-in-core-index.txt, which doesn't help for understanding the given function. It would be better to not find these functions in the documentation, such that people directly dive into the code instead. In the previous patches we have documented * index_name_pos() * remove_index_entry_at() * add_[file_]to_index() in cache.h We already have documentation for: * add_index_entry() * read_index() Which leaves us with a TODO for: * cache -> the_index macros * refresh_index() * discard_index() * ie_match_stat() and ie_modified(); how they are different and when to use which. * write_index() that was renamed to write_locked_index * cache_tree_invalidate_path() * cache_tree_update() Signed-off-by: Stefan Beller <sbeller@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>		2017-01-19 12:18:43 -08:00
..
howto	Merge branch 'po/fix-doc-merge-base-illustration' into maint	2016-10-28 09:01:21 -07:00
RelNotes	Almost ready for 2.11.1	2017-01-17 15:19:11 -08:00
technical	documentation: retire unfinished documentation	2017-01-19 12:18:43 -08:00
.gitattributes
.gitignore
asciidoc.conf
blame-options.txt
build-docdep.perl
cat-texi.perl
cmd-list.perl
CodingGuidelines	CodingGuidelines: formatting HEAD in documentation	2016-06-28 08:36:45 -07:00
config.txt	Merge branch 'mm/gc-safety-doc' into maint	2017-01-17 15:19:11 -08:00
date-formats.txt	Merge branch 'lr/doc-fix-cet' into maint	2017-01-17 15:19:08 -08:00
diff-config.txt	Merge branch 'jc/ws-error-highlight'	2016-10-26 13:14:43 -07:00
diff-format.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
diff-generate-patch.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
diff-heuristic-options.txt	blame: honor the diff heuristic options and config	2016-09-19 10:25:11 -07:00
diff-options.txt	Merge branch 'nd/ita-empty-commit'	2016-10-27 14:58:50 -07:00
docbook-xsl.css
docbook.xsl
everyday.txto
fetch-options.txt	Merge branch 'nd/shallow-deepen'	2016-10-10 14:03:50 -07:00
fix-texi.perl
fmt-merge-msg-config.txt
git-add.txt	add: document the chmod option	2016-09-12 15:03:32 -07:00
git-am.txt	Merge branch 'mm/doc-tt'	2016-07-13 11:24:14 -07:00
git-annotate.txt	blame: honor the diff heuristic options and config	2016-09-19 10:25:11 -07:00
git-apply.txt
git-archimport.txt
git-archive.txt
git-bisect-lk2009.txt
git-bisect.txt	doc: typeset HEAD and variants as literal	2016-06-28 08:36:45 -07:00
git-blame.txt	Merge branch 'jc/blame-reverse'	2016-10-10 14:03:51 -07:00
git-branch.txt	doc: typeset HEAD and variants as literal	2016-06-28 08:36:45 -07:00
git-bundle.txt
git-cat-file.txt	cat-file: support --textconv/--filters in batch mode	2016-09-11 14:48:15 -07:00
git-check-attr.txt
git-check-ignore.txt
git-check-mailmap.txt
git-check-ref-format.txt	git-check-ref-format.txt: fixup documentation	2016-09-21 11:12:41 -07:00
git-checkout-index.txt
git-checkout.txt	checkout.txt: document a common case that ignores ambiguation rules	2016-09-21 08:44:41 -07:00
git-cherry-pick.txt	Merge branch 'mm/doc-tt' into maint	2016-07-28 11:25:54 -07:00
git-cherry.txt
git-citool.txt
git-clean.txt
git-clone.txt	Merge branch 'nd/shallow-deepen'	2016-10-10 14:03:50 -07:00
git-column.txt
git-commit-tree.txt	Merge branch 'mm/doc-tt' into maint	2016-07-28 11:25:54 -07:00
git-commit.txt	Merge branch 'ak/commit-only-allow-empty' into maint	2017-01-17 15:11:03 -08:00
git-config.txt	Merge branch 'dg/document-git-c-in-git-config-doc' into maint	2016-09-08 21:35:56 -07:00
git-count-objects.txt	count-objects: report alternates via verbose mode	2016-10-10 13:52:37 -07:00
git-credential-cache--daemon.txt
git-credential-cache.txt
git-credential-store.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
git-credential.txt
git-cvsexportcommit.txt
git-cvsimport.txt	Merge branch 'jk/doc-cvs-update' into maint	2016-10-03 13:22:25 -07:00
git-cvsserver.txt	doc: typeset HEAD and variants as literal	2016-06-28 08:36:45 -07:00
git-daemon.txt	doc: typeset HEAD and variants as literal	2016-06-28 08:36:45 -07:00
git-describe.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
git-diff-files.txt
git-diff-index.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
git-diff-tree.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
git-diff.txt
git-difftool.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
git-fast-export.txt
git-fast-import.txt	Merge branch 'mm/doc-tt'	2016-07-13 11:24:14 -07:00
git-fetch-pack.txt	upload-pack: optionally allow fetching any sha1	2016-11-18 13:06:14 -08:00
git-fetch.txt	Merge branch 'mm/push-social-engineering-attack-doc' into maint	2017-01-17 15:19:10 -08:00
git-filter-branch.txt	doc: typeset '--' as literal	2016-06-28 08:36:45 -07:00
git-fmt-merge-msg.txt	Documentation/fmt-merge-msg: fix markup in example	2016-10-28 05:51:51 -07:00
git-for-each-ref.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
git-format-patch.txt	format-patch: add "--rfc" for the common case of [RFC PATCH]	2016-09-21 08:58:10 -07:00
git-fsck-objects.txt
git-fsck.txt	fsck: optionally show more helpful info for broken links	2016-07-18 15:15:59 -07:00
git-gc.txt	Merge branch 'mm/gc-safety-doc' into maint	2017-01-17 15:19:11 -08:00
git-get-tar-commit-id.txt
git-grep.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
git-gui.txt	doc: typeset HEAD and variants as literal	2016-06-28 08:36:45 -07:00
git-hash-object.txt
git-help.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
git-http-backend.txt
git-http-fetch.txt
git-http-push.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
git-imap-send.txt
git-index-pack.txt	index-pack: add --max-input-size=<size> option	2016-08-24 12:31:05 -07:00
git-init-db.txt
git-init.txt	Merge branch 'tr/doc-tt' into maint	2016-07-06 13:06:34 -07:00
git-instaweb.txt
git-interpret-trailers.txt	doc: mention user-configured trailers	2016-11-21 12:49:57 -08:00
git-log.txt	Merge branch 'mj/log-show-signature-conf'	2016-07-11 10:31:08 -07:00
git-ls-files.txt	ls-files: add pathspec matching for submodules	2016-10-10 12:14:58 -07:00
git-ls-remote.txt
git-ls-tree.txt	doc: typeset HEAD and variants as literal	2016-06-28 08:36:45 -07:00
git-mailinfo.txt
git-mailsplit.txt
git-merge-base.txt	doc: fix merge-base ASCII art tab spacing	2016-10-21 09:46:48 -07:00
git-merge-file.txt
git-merge-index.txt
git-merge-one-file.txt
git-merge-tree.txt
git-merge.txt
git-mergetool--lib.txt
git-mergetool.txt	mergetool: honor -O<orderfile>	2016-10-11 10:04:31 -07:00
git-mktag.txt
git-mktree.txt
git-mv.txt
git-name-rev.txt
git-notes.txt
git-p4.txt	Merge branch 'mm/doc-tt' into maint	2016-07-28 11:25:54 -07:00
git-pack-objects.txt	document git-repack interaction of pack.threads and pack.windowMemory	2016-08-10 10:55:13 -07:00
git-pack-redundant.txt
git-pack-refs.txt
git-parse-remote.txt
git-patch-id.txt
git-prune-packed.txt
git-prune.txt
git-pull.txt	Merge branch 'mm/push-social-engineering-attack-doc' into maint	2017-01-17 15:19:10 -08:00
git-push.txt	Merge branch 'mm/push-social-engineering-attack-doc' into maint	2017-01-17 15:19:10 -08:00
git-quiltimport.txt
git-read-tree.txt
git-rebase.txt	Merge branch 'mm/doc-tt' into maint	2016-07-28 11:25:54 -07:00
git-receive-pack.txt	receive-pack: allow a maximum input size to be specified	2016-08-24 12:31:05 -07:00
git-reflog.txt
git-relink.txt
git-remote-ext.txt
git-remote-fd.txt	Spelling fixes	2016-08-11 14:35:42 -07:00
git-remote-helpers.txto
git-remote-testgit.txt
git-remote.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
git-repack.txt	Merge branch 'ms/document-pack-window-memory-is-per-thread'	2016-08-12 09:47:35 -07:00
git-replace.txt
git-request-pull.txt
git-rerere.txt
git-reset.txt
git-rev-list.txt
git-rev-parse.txt
git-revert.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
git-rm.txt
git-send-email.txt	Merge branch 'mm/doc-tt' into maint	2016-07-28 11:25:54 -07:00
git-send-pack.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
git-sh-i18n--envsubst.txt
git-sh-i18n.txt
git-sh-setup.txt
git-shell.txt
git-shortlog.txt
git-show-branch.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
git-show-index.txt
git-show-ref.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
git-show.txt
git-stage.txt
git-stash.txt	stash: allow stashes to be referenced by index only	2016-10-26 09:58:10 -07:00
git-status.txt	git-status.txt: describe --porcelain=v2 format	2016-08-11 11:15:56 -07:00
git-stripspace.txt
git-submodule.txt	submodules doc: update documentation for "." used for submodule branches	2016-10-19 14:58:53 -07:00
git-svn.txt	Merge branch 'mm/doc-tt' into maint	2016-07-28 11:25:54 -07:00
git-symbolic-ref.txt
git-tag.txt	Merge branch 'yk/git-tag-remove-mention-of-old-layout-in-doc' into maint	2016-10-28 09:01:10 -07:00
git-tools.txt
git-unpack-file.txt
git-unpack-objects.txt	unpack-objects: add --max-input-size=<size> option	2016-08-24 12:31:05 -07:00
git-update-index.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
git-update-ref.txt
git-update-server-info.txt
git-upload-archive.txt
git-upload-pack.txt
git-var.txt
git-verify-commit.txt	Merge branch 'dn/gpg-doc' into maint	2016-07-06 13:06:36 -07:00
git-verify-pack.txt
git-verify-tag.txt
git-web--browse.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
git-whatchanged.txt
git-worktree.txt	Merge branch 'nd/worktree-lock' into maint	2016-11-29 13:28:02 -08:00
git-write-tree.txt
git.txt	Almost ready for 2.11.1	2017-01-17 15:19:11 -08:00
gitattributes.txt	docs: warn about possible '=' in clean/smudge filter process values	2016-12-06 11:29:52 -08:00
gitcli.txt
gitcore-tutorial.txt	doc: omit needless "for"	2016-12-09 15:14:01 -08:00
gitcredentials.txt
gitcvs-migration.txt	docs/cvs-migration: mention cvsimport caveats	2016-09-22 11:23:45 -07:00
gitdiffcore.txt	doc: typeset long command-line options as literal	2016-06-28 08:36:45 -07:00
giteveryday.txt
gitglossary.txt
githooks.txt	push options: {pre,post}-receive hook learns about push options	2016-07-14 15:50:17 -07:00
gitignore.txt
gitk.txt	Merge branch 'po/range-doc' into maint	2016-09-19 13:51:38 -07:00
gitmodules.txt	Merge branch 'bw/submodule-branch-dot-doc' into maint	2016-10-28 09:01:19 -07:00
gitnamespaces.txt	doc: mention transfer data leaks in more places	2016-11-14 11:23:07 -08:00
gitremote-helpers.txt	Merge branch 'nd/shallow-deepen'	2016-10-10 14:03:50 -07:00
gitrepository-layout.txt	doc: fix location of 'info/' with $GIT_COMMON_DIR	2016-11-11 09:37:33 -08:00
gitrevisions.txt	doc: gitrevisions - clarify 'latter case' is revision walk	2016-08-13 19:36:44 -07:00
gittutorial-2.txt
gittutorial.txt
gitweb.conf.txt	gitweb: use highlight's shebang detection	2016-09-25 16:39:11 -07:00
gitweb.txt
gitworkflows.txt
glossary-content.txt
howto-index.sh
i18n.txt
install-doc-quick.sh
install-webdoc.sh
line-range-format.txt
lint-gitlink.perl
mailmap.txt
Makefile
manpage-1.72.xsl
manpage-base-url.xsl.in
manpage-base.xsl
manpage-bold-literal.xsl
manpage-normal.xsl
manpage-quote-apos.xsl
manpage-suppress-sp.xsl
merge-config.txt
merge-options.txt
merge-strategies.txt
pretty-formats.txt	Merge branch 'rs/pretty-format-color-doc-fix' into maint	2016-10-28 09:01:23 -07:00
pretty-options.txt	Merge branch 'tr/doc-tt' into maint	2016-07-06 13:06:34 -07:00
pull-fetch-param.txt
rev-list-options.txt	Merge branch 'pb/rev-list-reverse-with-count' into maint	2016-10-11 14:20:06 -07:00
revisions.txt	revision: new rev^-n shorthand for rev^n..rev	2016-09-27 10:59:28 -07:00
sequencer.txt
SubmittingPatches	SubmittingPatches: use gitk's "Copy commit summary" format	2016-08-26 15:58:10 -07:00
transfer-data-leaks.txt	doc: mention transfer data leaks in more places	2016-11-14 11:23:07 -08:00
urls-remotes.txt
urls.txt
user-manual.conf
user-manual.txt