git/Documentation/git-replace.txt, branch v2.43.2

documentation: add missing article

2023-10-09T19:06:29Z

Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano

documentation: fix singular vs. plural

2023-10-09T19:06:29Z

Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano

Recommend git-filter-repo instead of git-filter-branch

2019-09-05T20:01:48Z

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 Signed-off-by: Junio C Hamano

replace: introduce --convert-graft-file

2018-04-30T02:12:30Z

This option is intended to help with the transition away from the now-deprecated graft file. Signed-off-by: Johannes Schindelin Signed-off-by: Junio C Hamano

doc: change environment variables format

2016-06-08T19:04:37Z

This change GIT_* variables that where in italic style to monospaced font according to the guideline. It was obtained with perl -pi -e "s/\'(GIT_.*?)\'/\`\1\`/g" *.txt One of the main purposes is to stick to the CodingGuidelines as possible so that people writting new documentation by mimicking the existing are more likely to have it right (even if they didn't read the CodingGuidelines). Signed-off-by: Tom Russello Signed-off-by: Erwan Mathoniere Signed-off-by: Samuel Groot Signed-off-by: Matthieu Moy Reviewed-by: Matthieu Moy Signed-off-by: Junio C Hamano

Merge branch 'cc/replace-graft'

2014-07-27T22:14:18Z

"git replace" learned a "--graft" option to rewrite parents of a commit. * cc/replace-graft: replace: add test for --graft with a mergetag replace: check mergetags when using --graft replace: add test for --graft with signed commit replace: remove signature when using --graft contrib: add convert-grafts-to-replace-refs.sh Documentation: replace: add --graft option replace: add test for --graft replace: add --graft option replace: cleanup redirection style in tests

contrib: add convert-grafts-to-replace-refs.sh

2014-07-21T19:05:53Z

This patch adds into contrib/ an example script to convert grafts from an existing grafts file into replace refs using the new --graft option of "git replace". While at it let's mention this new script in the "git replace" documentation for the --graft option. Signed-off-by: Christian Couder Signed-off-by: Junio C Hamano

Documentation: replace: add --graft option

2014-07-21T19:05:47Z

Signed-off-by: Christian Couder Signed-off-by: Junio C Hamano

replace: add a --raw mode for --edit

2014-06-25T22:28:28Z

One of the purposes of "git replace --edit" is to help a user repair objects which are malformed or corrupted. Usually we pretty-print trees with "ls-tree", which is much easier to work with than the raw binary data. However, some forms of corruption break the tree-walker, in which case our pretty-printing fails, rendering "--edit" useless for the user. This patch introduces a "--raw" option, which lets you edit the binary data in these instances. Signed-off-by: Jeff King Signed-off-by: Junio C Hamano

Documentation: replace: describe new --edit option

2014-05-19T20:39:54Z

Signed-off-by: Christian Couder Signed-off-by: Junio C Hamano