Elijah Newren 9df53c5de6 Recommend git-filter-repo instead of git-filter-branch ... filter-branch suffers from a deluge of disguised dangers that disfigure history rewrites (i.e. deviate from the deliberate changes). Many of these problems are unobtrusive and can easily go undiscovered until the new repository is in use. This can result in problems ranging from an even messier history than what led folks to filter-branch in the first place, to data loss or corruption. These issues cannot be backward compatibly fixed, so add a warning to both filter-branch and its manpage recommending that another tool (such as filter-repo) be used instead. Also, update other manpages that referenced filter-branch. Several of these needed updates even if we could continue recommending filter-branch, either due to implying that something was unique to filter-branch when it applied more generally to all history rewriting tools (e.g. BFG, reposurgeon, fast-import, filter-repo), or because something about filter-branch was used as an example despite other more commonly known examples now existing. Reword these sections to fix these issues and to avoid recommending filter-branch. Finally, remove the section explaining BFG Repo Cleaner as an alternative to filter-branch. I feel somewhat bad about this, especially since I feel like I learned so much from BFG that I put to good use in filter-repo (which is much more than I can say for filter-branch), but keeping that section presented a few problems: * In order to recommend that people quit using filter-branch, we need to provide them a recomendation for something else to use that can handle all the same types of rewrites. To my knowledge, filter-repo is the only such tool. So it needs to be mentioned. * I don't want to give conflicting recommendations to users * If we recommend two tools, we shouldn't expect users to learn both and pick which one to use; we should explain which problems one can solve that the other can't or when one is much faster than the other. * BFG and filter-repo have similar performance * All filtering types that BFG can do, filter-repo can also do. In fact, filter-repo comes with a reimplementation of BFG named bfg-ish which provides the same user-interface as BFG but with several bugfixes and new features that are hard to implement in BFG due to its technical underpinnings. While I could still mention both tools, it seems like I would need to provide some kind of comparison and I would ultimately just say that filter-repo can do everything BFG can, so ultimately it seems that it is just better to remove that section altogether. Signed-off-by: Elijah Newren <newren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>		2019-09-05 13:01:48 -07:00
..
RelNotes	First batch after Git 2.23	2019-08-22 12:41:04 -07:00
config	doc: fix repeated words	2019-08-11 17:40:07 -07:00
howto	doc: format pathnames and URLs as monospace.	2019-03-13 11:14:22 +09:00
technical	Merge branch 'jk/tree-walk-overflow'	2019-08-22 12:34:10 -07:00
.gitattributes	…
.gitignore	Merge branch 'js/misc-doc-fixes'	2019-05-09 00:37:27 +09:00
CodingGuidelines	Merge branch 'jc/post-c89-rules-doc' into maint	2019-07-29 12:38:23 -07:00
Makefile	Merge branch 'es/first-contrib-tutorial'	2019-06-17 10:15:19 -07:00
MyFirstContribution.txt	doc: improve usage string in MyFirstContribution	2019-06-24 10:55:38 -07:00
SubmittingPatches	doc: format pathnames and URLs as monospace.	2019-03-13 11:14:22 +09:00
asciidoc.conf	…
asciidoctor-extensions.rb	asciidoctor-extensions: fix spurious space after linkgit	2019-03-11 18:22:07 +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	…
cmd-list.perl	…
config.txt	config: learn the "onbranch:" includeIf condition	2019-06-05 14:38:28 -07:00
date-formats.txt	…
diff-format.txt	log,diff-tree: add --combined-all-paths option	2019-02-07 20:15:25 -08:00
diff-generate-patch.txt	log,diff-tree: add --combined-all-paths option	2019-02-07 20:15:25 -08:00
diff-options.txt	Merge branch 'nd/diff-parseopt-3'	2019-04-16 19:28:03 +09:00
doc-diff	doc-diff: add `--cut-header-footer`	2019-03-18 15:54:17 +09:00
docbook-xsl.css	…
docbook.xsl	…
everyday.txto	…
fetch-options.txt	Merge branch 'ds/fetch-disable-force-notice'	2019-07-09 15:25:46 -07: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	am/cherry-pick/rebase/revert: document --rerere-autoupdate	2019-03-18 10:24:56 +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 'nd/switch-and-restore'	2019-07-09 15:25:44 -07: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: verify chains with --shallow mode	2019-06-19 20:46:26 -07:00
git-commit-tree.txt	commit-tree: utilize parse-options api	2019-03-08 10:31:24 +09:00
git-commit.txt	doc: promote "git restore"	2019-05-07 13:04:48 +09:00
git-config.txt	Merge branch 'ma/asciidoctor-fixes-more'	2019-04-16 19:28:04 +09:00
git-count-objects.txt	…
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	…
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	Recommend git-filter-repo instead of git-filter-branch	2019-09-05 13:01:48 -07:00
git-fast-import.txt	Merge branch 'en/fast-import-merge-doc'	2019-08-22 12:34:12 -07: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 'nd/switch-and-restore'	2019-07-09 15:25:44 -07: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	Documentation: turn middle-of-line tabs into spaces	2019-03-07 09:25:32 +09:00
git-gui.txt	…
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	Documentation: turn middle-of-line tabs into spaces	2019-03-07 09:25:32 +09:00
git-ls-tree.txt	doc: format pathnames and URLs as monospace.	2019-03-13 11:14:22 +09:00
git-mailinfo.txt	…
git-mailsplit.txt	…
git-merge-base.txt	doc: promote "git switch"	2019-04-02 13:57:00 +09:00
git-merge-file.txt	…
git-merge-index.txt	…
git-merge-one-file.txt	…
git-merge-tree.txt	…
git-merge.txt	Merge branch 'nd/switch-and-restore'	2019-07-09 15:25:44 -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: prepare 'repack' subcommand	2019-06-11 10:34:40 -07:00
git-mv.txt	…
git-name-rev.txt	doc: keep first level section header in upper case	2018-05-02 17:03:33 +09:00
git-notes.txt	Documentation: turn middle-of-line tabs into spaces	2019-03-07 09:25:32 +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	Merge branch 'nd/checkout-m'	2019-04-25 16:41:14 +09:00
git-rebase.txt	Recommend git-filter-repo instead of git-filter-branch	2019-09-05 13:01:48 -07:00
git-receive-pack.txt	doc: keep first level section header in upper case	2018-05-02 17:03:33 +09: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	rev-list: teach --no-object-names to enable piping	2019-06-20 13:13:04 -07:00
git-rev-parse.txt	Use proper syntax for replaceables in command docs	2018-05-25 17:16:47 +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	Merge branch 'cm/send-email-document-req-modules'	2019-06-21 11:24:10 -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	…
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-stage.txt	…
git-stash.txt	Merge branch 'nd/switch-and-restore'	2019-07-09 15:25:44 -07:00
git-status.txt	Documentation/git-status: fix titles in porcelain v2 section	2019-04-01 17:46:26 +09:00
git-stripspace.txt	…
git-submodule.txt	Merge branch 'dl/submodule-set-branch'	2019-04-25 16:41:18 +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	…
git-unpack-file.txt	…
git-unpack-objects.txt	…
git-update-index.txt	Merge branch 'jc/update-index-doc'	2018-08-20 11:33:50 -07: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	…
git-verify-pack.txt	…
git-verify-tag.txt	…
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	Merge branch 'nd/switch-and-restore'	2019-07-09 15:25:44 -07:00
gitcli.txt	doc: promote "git restore"	2019-05-07 13:04:48 +09: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	…
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	…
githooks.txt	Recommend git-filter-repo instead of git-filter-branch	2019-09-05 13:01:48 -07: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	doc: format pathnames and URLs as monospace.	2019-03-13 11:14:22 +09:00
gitnamespaces.txt	…
gitremote-helpers.txt	Merge branch 'js/check-docs-exe'	2019-04-22 11:14:46 +09:00
gitrepository-layout.txt	doc: format pathnames and URLs as monospace.	2019-03-13 11:14:22 +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	Merge branch 'cb/doco-mono'	2019-04-22 11:14:45 +09: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	…
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-options.txt	Merge branch 'vv/merge-squash-with-explicit-commit' into maint	2019-07-25 14:27:10 -07:00
merge-strategies.txt	merge: add merge.renames config setting	2018-05-08 16:19:41 +09:00
pretty-formats.txt	Merge branch 'aw/pretty-trailers'	2019-03-07 09:59:52 +09:00
pretty-options.txt	…
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 'jk/check-connected-with-alternates'	2019-07-19 11:30:21 -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
texi.xsl	…
trace2-target-values.txt	trace2: update docs to describe system/global config settings	2019-04-16 13:37:07 +09:00
transfer-data-leaks.txt	…
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	doc: promote "git restore"	2019-05-07 13:04:48 +09:00