admin/git
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
94c0956b60969bbbb3ead19638d52591a59d713c
git/Documentation
History
Derrick Stolee 94c0956b60 sparse-checkout: create builtin with 'list' subcommand 
The sparse-checkout feature is mostly hidden to users, as its
only documentation is supplementary information in the docs for
'git read-tree'. In addition, users need to know how to edit the
.git/info/sparse-checkout file with the right patterns, then run
the appropriate 'git read-tree -mu HEAD' command. Keeping the
working directory in sync with the sparse-checkout file requires
care.

Begin an effort to make the sparse-checkout feature a porcelain
feature by creating a new 'git sparse-checkout' builtin. This
builtin will be the preferred mechanism for manipulating the
sparse-checkout file and syncing the working directory.

The documentation provided is adapted from the "git read-tree"
documentation with a few edits for clarity in the new context.
Extra sections are added to hint toward a future change to
a more restricted pattern set.

Helped-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2019-11-22 16:11:43 +09:00
..
config
Merge branch 'dl/format-patch-cover-from-desc'
2019-11-10 18:02:11 +09:00
howto
doc: format pathnames and URLs as monospace.
2019-03-13 11:14:22 +09:00
RelNotes
The first batch post 2.24 cycle
2019-11-10 18:02:17 +09:00
technical
documentation: remove empty doc files
2019-10-25 11:18:14 +09:00
.gitattributes
…
.gitignore
Merge branch 'js/misc-doc-fixes'
2019-05-09 00:37:27 +09:00
asciidoc.conf
Doc/Makefile: give mansource/-version/-manual attributes
2019-09-16 12:27:34 -07:00
asciidoctor-extensions.rb
Merge branch 'ma/user-manual-markup-update'
2019-10-06 12:25:16 +09:00
blame-options.txt
blame: add config options for the output of ignored or unblamable lines
2019-05-16 11:36:23 +09:00
build-docdep.perl
…
cat-texi.perl
Documentation: remove unneeded argument in cat-texi.perl
2017-01-23 10:56:47 -08:00
cmd-list.perl
…
CodingGuidelines
Merge branch 'jc/post-c89-rules-doc' into maint
2019-07-29 12:38:23 -07:00
config.txt
Merge branch 'ma/asciidoctor-more-fixes'
2019-10-06 12:25:16 +09:00
date-formats.txt
Merge branch 'lr/doc-fix-cet' into maint
2017-01-17 15:19:08 -08:00
diff-format.txt
log,diff-tree: add --combined-all-paths option
2019-02-07 20:15:25 -08:00
diff-generate-patch.txt
diff, log doc: small grammer, format, and language fixes
2019-09-17 12:14:06 -07:00
diff-options.txt
Merge branch 'nd/diff-parseopt-3'
2019-04-16 19:28:03 +09:00
doc-diff
doc-diff: replace --cut-header-footer with --cut-footer
2019-09-16 12:27:38 -07:00
docbook-xsl.css
…
docbook.xsl
…
everyday.txto
…
fetch-options.txt
Merge branch 'js/fetch-jobs'
2019-10-15 13:48:00 +09:00
fix-texi.perl
…
git-add.txt
docs: move core.excludesFile from git-add to gitignore
2019-03-08 09:12:45 +09:00
git-am.txt
doc: am --show-current-patch gives an entire e-mail message
2019-10-23 11:26:37 +09:00
git-annotate.txt
Use proper syntax for replaceables in command docs
2018-05-25 17:16:47 +09:00
git-apply.txt
Merge branch 'nd/diff-apply-ita'
2018-06-25 13:22:36 -07:00
git-archimport.txt
git-archimport.1: specify what kind of Arch we're talking about
2018-09-21 09:28:58 -07:00
git-archive.txt
…
git-bisect-lk2009.txt
doc: fix ASCII art tab spacing
2018-10-23 12:23:09 +09:00
git-bisect.txt
Merge branch 'ak/bisect-doc-typofix'
2018-04-25 13:28:56 +09:00
git-blame.txt
blame: add the ability to ignore commits and their changes
2019-05-16 11:36:23 +09:00
git-branch.txt
Merge branch 'po/doc-branch' into maint
2019-07-29 12:38:16 -07:00
git-bundle.txt
doc: keep first level section header in upper case
2018-05-02 17:03:33 +09:00
git-cat-file.txt
Merge branch 'dt/cat-file-batch-ambiguous'
2019-02-06 22:05:21 -08:00
git-check-attr.txt
Use proper syntax for replaceables in command docs
2018-05-25 17:16:47 +09:00
git-check-ignore.txt
Use proper syntax for replaceables in command docs
2018-05-25 17:16:47 +09:00
git-check-mailmap.txt
Use proper syntax for replaceables in command docs
2018-05-25 17:16:47 +09:00
git-check-ref-format.txt
doc: promote "git switch"
2019-04-02 13:57:00 +09:00
git-checkout-index.txt
…
git-checkout.txt
Merge branch 'nd/switch-and-restore'
2019-07-09 15:25:44 -07:00
git-cherry-pick.txt
cherry-pick/revert: add --skip option
2019-07-02 12:08:08 -07:00
git-cherry.txt
…
git-citool.txt
…
git-clean.txt
Merge branch 'en/clean-nested-with-ignored'
2019-10-11 14:24:46 +09:00
git-clone.txt
Merge branch 'qn/clone-doc-use-long-form'
2019-07-11 15:16:48 -07:00
git-column.txt
git-column.txt: fix section header
2018-12-26 15:29:30 -08:00
git-commit-graph.txt
commit-graph: add --[no-]progress to write and verify
2019-09-18 14:23:09 -07:00
git-commit-tree.txt
commit-tree: utilize parse-options api
2019-03-08 10:31:24 +09:00
git-commit.txt
Documentation: wrap blocks with "--"
2019-09-09 11:05:51 -07:00
git-config.txt
Documentation: wrap config listings in "----"
2019-09-09 11:05:51 -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
Use proper syntax for replaceables in command docs
2018-05-25 17:16:47 +09:00
git-credential-store.txt
Use proper syntax for replaceables in command docs
2018-05-25 17:16:47 +09: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: typo: s/can not/cannot/ and s/is does/does/
2019-08-05 10:05:24 -07:00
git-daemon.txt
doc: format pathnames and URLs as monospace.
2019-03-13 11:14:22 +09:00
git-describe.txt
describe doc: remove '7-char' abbreviation reference
2019-04-08 17:24:51 +09:00
git-diff-files.txt
…
git-diff-index.txt
doc: keep first level section header in upper case
2018-05-02 17:03:33 +09:00
git-diff-tree.txt
Documentation/git-diff-tree.txt: fix formatting
2019-04-01 15:17:47 +09:00
git-diff.txt
doc: tidy asciidoc style
2019-01-23 11:37:29 -08:00
git-difftool.txt
difftool: fallback on merge.guitool
2019-05-13 23:11:59 +09:00
git-fast-export.txt
Merge branch 'en/fast-imexport-nested-tags'
2019-10-15 13:48:00 +09:00
git-fast-import.txt
fast-import: add support for new 'alias' command
2019-10-04 07:33:21 +09:00
git-fetch-pack.txt
Documentation: fix several one-character-off spelling errors
2018-04-09 14:15:02 +09:00
git-fetch.txt
doc: typo: s/can not/cannot/ and s/is does/does/
2019-08-05 10:05:24 -07:00
git-filter-branch.txt
Recommend git-filter-repo instead of git-filter-branch
2019-09-05 13:01:48 -07:00
git-fmt-merge-msg.txt
config.txt: move fmt-merge-msg-config.txt to config/
2018-10-29 10:17:01 +09:00
git-for-each-ref.txt
ref-filter: add worktreepath atom
2019-05-07 13:45:53 +09:00
git-format-patch.txt
Merge branch 'dl/format-patch-cover-from-desc'
2019-11-10 18:02:11 +09:00
git-fsck-objects.txt
…
git-fsck.txt
Documentation/git-fsck.txt: include fsck.* config variables
2019-07-29 10:41:18 -07:00
git-gc.txt
Recommend git-filter-repo instead of git-filter-branch
2019-09-05 13:01:48 -07:00
git-get-tar-commit-id.txt
…
git-grep.txt
grep: make the behavior for NUL-byte in patterns sane
2019-07-01 14:33:14 -07:00
git-gui.txt
Documentation: update the location of the git-gui repo
2019-10-06 09:45:02 +09:00
git-hash-object.txt
hash-object doc: stop mentioning git-cvsimport
2019-05-28 10:47:42 -07:00
git-help.txt
doc: format pathnames and URLs as monospace.
2019-03-13 11:14:22 +09:00
git-http-backend.txt
Documentation: turn middle-of-line tabs into spaces
2019-03-07 09:25:32 +09:00
git-http-fetch.txt
http-fetch: make -a standard behaviour
2018-04-24 10:55:02 +09:00
git-http-push.txt
doc: keep first level section header in upper case
2018-05-02 17:03:33 +09:00
git-imap-send.txt
git-imap-send.txt: move imap.* to a separate file
2018-10-29 10:17:02 +09:00
git-index-pack.txt
doc: keep first level section header in upper case
2018-05-02 17:03:33 +09:00
git-init-db.txt
…
git-init.txt
Merge branch 'km/init-doc-typofix'
2019-02-06 22:05:21 -08:00
git-instaweb.txt
git-instaweb: add Python builtin http.server support
2019-01-28 10:57:44 -08:00
git-interpret-trailers.txt
interpret-trailers.txt: start the desc line with a capital letter
2019-04-01 15:49:47 +09:00
git-log.txt
documentation: mention --no-use-mailmap and log.mailmap false setting
2019-07-15 11:44:26 -07:00
git-ls-files.txt
doc/ls-files: put nested list for "-t" option into block
2019-04-23 10:25:04 +09:00
git-ls-remote.txt
git-ls-remote.txt: wrap shell listing in "----"
2019-09-09 11:05:52 -07:00
git-ls-tree.txt
doc: format pathnames and URLs as monospace.
2019-03-13 11:14:22 +09:00
git-mailinfo.txt
Merge branch 'va/mailinfo-doc-typofix' into maint
2016-05-26 13:17:14 -07:00
git-mailsplit.txt
mailsplit: support unescaping mboxrd messages
2016-06-06 11:14:43 -07:00
git-merge-base.txt
git-merge-base.txt: render indentations correctly under Asciidoctor
2019-09-09 11:05:51 -07:00
git-merge-file.txt
…
git-merge-index.txt
git-merge-index.txt: wrap shell listing in "----"
2019-09-09 11:05:52 -07:00
git-merge-one-file.txt
…
git-merge-tree.txt
…
git-merge.txt
merge: do no-verify like commit
2019-08-07 12:37:33 -07:00
git-mergetool--lib.txt
mergetool: use get_merge_tool function
2019-05-13 23:11:59 +09:00
git-mergetool.txt
mergetool: fallback to tool when guitool unavailable
2019-05-13 23:11:59 +09:00
git-mktag.txt
…
git-mktree.txt
Documentation: normalize spelling of 'normalised'
2018-04-09 14:15:07 +09:00
git-multi-pack-index.txt
multi-pack-index: add [--[no-]progress] option.
2019-10-23 12:05:06 +09:00
git-mv.txt
doc: typeset short command-line options as literal
2016-06-28 08:20:52 -07:00
git-name-rev.txt
doc: keep first level section header in upper case
2018-05-02 17:03:33 +09:00
git-notes.txt
notes: fix minimum number of parameters to "copy" subcommand
2019-10-18 09:43:10 +09:00
git-p4.txt
doc: tidy asciidoc style
2019-01-23 11:37:29 -08:00
git-pack-objects.txt
doc: fix repeated words
2019-08-11 17:40:07 -07:00
git-pack-redundant.txt
…
git-pack-refs.txt
…
git-parse-remote.txt
…
git-patch-id.txt
doc: remove unsupported parameter from patch-id
2017-07-28 14:41:32 -07:00
git-prune-packed.txt
…
git-prune.txt
doc: keep first level section header in upper case
2018-05-02 17:03:33 +09:00
git-pull.txt
doc: typo: s/can not/cannot/ and s/is does/does/
2019-08-05 10:05:24 -07:00
git-push.txt
doc: fix repeated words
2019-08-11 17:40:07 -07:00
git-quiltimport.txt
git-quiltimport: add --keep-non-patch option
2019-01-07 15:29:34 -08:00
git-range-diff.txt
range-diff doc: add a section about output stability
2018-11-12 12:05:38 +09:00
git-read-tree.txt
sparse-checkout: create builtin with 'list' subcommand
2019-11-22 16:11:43 +09:00
git-rebase.txt
Merge branch 'dl/rebase-i-keep-base'
2019-09-30 13:19:31 +09:00
git-receive-pack.txt
git-receive-pack.txt: wrap shell [script] listing in "----"
2019-09-09 11:05:52 -07:00
git-reflog.txt
reflog expire: cover reflog from all worktrees
2018-10-22 13:32:54 +09:00
git-remote-ext.txt
Merge branch 'js/check-docs-exe'
2019-04-22 11:14:46 +09:00
git-remote-fd.txt
docs: move gitremote-helpers into section 7
2019-04-01 14:00:53 +09:00
git-remote-helpers.txto
docs: move gitremote-helpers into section 7
2019-04-01 14:00:53 +09:00
git-remote.txt
doc: promote "git switch"
2019-04-02 13:57:00 +09:00
git-repack.txt
doc: fix repeated words
2019-08-11 17:40:07 -07:00
git-replace.txt
Recommend git-filter-repo instead of git-filter-branch
2019-09-05 13:01:48 -07:00
git-request-pull.txt
doc: keep first level section header in upper case
2018-05-02 17:03:33 +09:00
git-rerere.txt
Merge branch 'nd/switch-and-restore'
2019-07-09 15:25:44 -07:00
git-reset.txt
Merge branch 'nd/switch-and-restore'
2019-07-09 15:25:44 -07:00
git-restore.txt
restore: fix typo in docs
2019-08-05 12:39:39 -07:00
git-rev-list.txt
git-rev-list.txt: prune options in synopsis
2019-10-06 09:45:19 +09:00
git-rev-parse.txt
rev-parse: add a --show-object-format option
2019-10-28 11:34:57 +09:00
git-revert.txt
Merge branch 'ra/cherry-pick-revert-skip'
2019-07-19 11:30:21 -07:00
git-rm.txt
treewide: correct several "up-to-date" to "up to date"
2017-08-23 12:17:22 -07:00
git-send-email.txt
Documentation: wrap config listings in "----"
2019-09-09 11:05:51 -07:00
git-send-pack.txt
doc: keep first level section header in upper case
2018-05-02 17:03:33 +09:00
git-sh-i18n--envsubst.txt
…
git-sh-i18n.txt
…
git-sh-setup.txt
doc: more consistency in environment variables format
2016-06-08 12:04:37 -07:00
git-shell.txt
doc: keep first level section header in upper case
2018-05-02 17:03:33 +09:00
git-shortlog.txt
git-[short]log.txt: unify quoted standalone --
2018-04-18 12:49:26 +09:00
git-show-branch.txt
Documentation/git-show-branch: avoid literal {apostrophe}
2019-04-10 12:05:03 +09:00
git-show-index.txt
show-index: update documentation for index v2
2018-05-29 00:28:22 +09:00
git-show-ref.txt
git-show-ref.txt: fix order of flags
2019-01-10 10:29:05 -08:00
git-show.txt
Use proper syntax for replaceables in command docs
2018-05-25 17:16:47 +09:00
git-sparse-checkout.txt
sparse-checkout: create builtin with 'list' subcommand
2019-11-22 16:11:43 +09:00
git-stage.txt
…
git-stash.txt
doc(stash): clarify the description of save
2019-10-11 14:28:04 +09:00
git-status.txt
Documentation: wrap blocks with "--"
2019-09-09 11:05:51 -07:00
git-stripspace.txt
…
git-submodule.txt
Merge branch 'dl/submodule-set-branch'
2019-10-07 11:32:56 +09:00
git-svn.txt
Recommend git-filter-repo instead of git-filter-branch
2019-09-05 13:01:48 -07:00
git-switch.txt
Declare both git-switch and git-restore experimental
2019-05-07 13:04:48 +09:00
git-symbolic-ref.txt
…
git-tag.txt
tag: add tag.gpgSign config option to force all tags be GPG-signed
2019-06-05 14:39:28 -07:00
git-tools.txt
doc: replace or.cz gitwiki link with git.wiki.kernel.org
2017-04-20 22:05:37 -07:00
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
update-index: optionally leave skip-worktree entries alone
2019-11-02 15:22:00 +09:00
git-update-ref.txt
Merge branch 'ah/doc-updates' into maint
2018-11-21 22:58:07 +09:00
git-update-server-info.txt
update-server-info: avoid needless overwrites
2019-05-15 14:07:37 +09:00
git-upload-archive.txt
…
git-upload-pack.txt
doc: tidy asciidoc style
2019-01-23 11:37:29 -08:00
git-var.txt
doc: keep first level section header in upper case
2018-05-02 17:03:33 +09:00
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
builtin/verify-tag: add --format to verify-tag
2017-01-17 16:10:22 -08:00
git-web--browse.txt
doc: format pathnames and URLs as monospace.
2019-03-13 11:14:22 +09:00
git-whatchanged.txt
…
git-worktree.txt
doc: fix typos in man pages
2019-03-18 14:45:21 +09:00
git-write-tree.txt
…
git.txt
Merge branch 'sg/git-C-empty-doc'
2019-07-11 15:16:48 -07:00
gitattributes.txt
userdiff: add a builtin pattern for dts files
2019-08-21 15:09:34 -07:00
gitcli.txt
gitcli: document --end-of-options
2019-08-06 13:05:39 -07:00
gitcore-tutorial.txt
doc: promote "git switch"
2019-04-02 13:57:00 +09:00
gitcredentials.txt
doc: clarify gitcredentials path component matching
2018-09-27 15:24:50 -07:00
gitcvs-migration.txt
Merge branch 'sb/doc-unify-bottom'
2017-02-15 12:54:20 -08:00
gitdiffcore.txt
log -G: ignore binary files
2018-12-26 14:59:37 -08:00
giteveryday.txt
doc: promote "git restore"
2019-05-07 13:04:48 +09:00
gitglossary.txt
Documentation: unify bottom "part of git suite" lines
2017-02-09 15:14:01 -08:00
githooks.txt
Merge branch 'en/filter-branch-deprecation'
2019-09-30 13:19:29 +09:00
gitignore.txt
Merge branch 'an/ignore-doc-update' into maint
2019-07-25 14:27:13 -07:00
gitk.txt
doc: format pathnames and URLs as monospace.
2019-03-13 11:14:22 +09:00
gitmodules.txt
Merge branch 'ah/doc-submodule-ignore-submodules'
2019-10-07 11:33:00 +09:00
gitnamespaces.txt
doc: mention transfer data leaks in more places
2016-11-14 11:23:07 -08:00
gitremote-helpers.txt
Merge branch 'bc/smart-http-atomic-push'
2019-10-23 14:43:11 +09:00
gitrepository-layout.txt
Merge branch 'sg/dir-trie-fixes'
2019-11-10 18:02:14 +09:00
gitrevisions.txt
push doc: correct lies about how push refspecs work
2018-08-31 14:04:06 -07:00
gitsubmodules.txt
gitsubmodules: align html and nroff lists
2019-05-28 09:42:06 -07:00
gittutorial-2.txt
doc: promote "git restore"
2019-05-07 13:04:48 +09:00
gittutorial.txt
doc: promote "git restore"
2019-05-07 13:04:48 +09:00
gitweb.conf.txt
gitweb.conf.txt: switch pluses to backticks to help Asciidoctor
2019-09-09 11:05:52 -07:00
gitweb.txt
doc: don't use git.kernel.org as example gitweb URL
2019-06-24 12:37:21 -07:00
gitworkflows.txt
doc: promote "git switch"
2019-04-02 13:57:00 +09:00
glossary-content.txt
doc: typo: s/can not/cannot/ and s/is does/does/
2019-08-05 10:05:24 -07:00
howto-index.sh
…
i18n.txt
doc: camelCase the i18n config variables to improve readability
2017-07-17 15:11:26 -07:00
install-doc-quick.sh
install-doc-quick: allow specifying what ref to install
2017-12-12 16:49:40 -08:00
install-webdoc.sh
…
line-range-format.txt
…
lint-gitlink.perl
…
mailmap.txt
…
Makefile
Merge branch 'es/walken-tutorial'
2019-11-10 18:02:11 +09:00
manpage-1.72.xsl
…
manpage-base-url.xsl.in
…
manpage-base.xsl
…
manpage-bold-literal.xsl
manpage-bold-literal.xsl: match for namespaced "d:literal" in template
2019-11-02 14:46:42 +09:00
manpage-normal.xsl
…
manpage-quote-apos.xsl
…
manpage-suppress-sp.xsl
…
manpage.xsl
Documentation: fix build with Asciidoctor 2
2019-09-16 12:20:39 -07:00
merge-options.txt
Merge branch 'en/merge-options-ff-and-friends'
2019-09-30 13:19:28 +09:00
merge-strategies.txt
merge: add merge.renames config setting
2018-05-08 16:19:41 +09:00
MyFirstContribution.txt
doc: MyFirstContribution: fix cmd placement instructions
2019-09-28 12:27:38 +09:00
MyFirstObjectWalk.txt
documentation: add tutorial for object walking
2019-10-12 10:29:15 +09:00
pretty-formats.txt
pretty: add "%aL" etc. to show local-part of email addresses
2019-10-30 11:49:41 +09:00
pretty-options.txt
Merge branch 'tr/doc-tt' into maint
2016-07-06 13:06:34 -07:00
pull-fetch-param.txt
fetch doc: correct grammar in --force docs
2018-09-20 09:40:03 -07:00
rev-list-options.txt
Merge branch 'md/list-objects-filter-combo'
2019-09-18 11:50:09 -07:00
revisions.txt
Merge branch 'nd/switch-and-restore'
2019-07-09 15:25:44 -07:00
sequencer.txt
cherry-pick/revert: add --skip option
2019-07-02 12:08:08 -07:00
SubmittingPatches
SubmittingPatches: git-gui has a new maintainer
2019-09-18 13:57:13 -07:00
texi.xsl
Documentation: add XSLT to fix DocBook for Texinfo
2017-01-23 10:56:53 -08:00
trace2-target-values.txt
docs: mention trace2 target-dir mode in git-config
2019-10-04 09:26:42 +09: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
docs: move gitremote-helpers into section 7
2019-04-01 14:00:53 +09:00
user-manual.conf
…
user-manual.txt
user-manual.txt: render ASCII art correctly under Asciidoctor
2019-09-28 17:39:34 +09:00