Skip to content

Commit

Permalink
Merge #5994: doc: replace gfd() function to recommendation to use `gi…
Browse files Browse the repository at this point in the history
…t diff-range`

f5f8bd9 doc: replace gfd() function to recommendation to use `git diff-range` (Konstantin Akimov)

Pull request description:

  ## Issue being fixed or feature implemented
  `gfd` is less convenient to use, `git range-diff` is more functional. Dropped recommendation to use it.

  ## What was done?
  Updated `CONTRIBUTION.md` file

  ## How Has This Been Tested?
  Run `git range-diff` to ensure that it indeed works

  ## Breaking Changes
  N/A

  ## Checklist:
  - [x] I have performed a self-review of my own code
  - [ ] I have commented my code, particularly in hard-to-understand areas
  - [ ] I have added or updated relevant unit/integration/functional/e2e tests
  - [x] I have made corresponding changes to the documentation
  - [x] I have assigned this pull request to a milestone

Top commit has no ACKs.

Tree-SHA512: 08663e5371753b6851b216da66ef72bb6bfb80acd42c31c57de9f8d52f00766e3121adf960e27236451d6520088f0c2c927f5f4f3001a40c591feb62074951e0
  • Loading branch information
PastaPastaPasta committed Apr 23, 2024
2 parents 6194e45 + f5f8bd9 commit 2610df3
Showing 1 changed file with 3 additions and 14 deletions.
17 changes: 3 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -348,20 +348,9 @@ a worthwhile change based on the judgement of the maintainers.

When someone rebases their PR, it can often be very difficult to ensure that
extra changes were not included in that force push. This changes could be anything
from merge conflicts to someone attempting to sneak something into the PR. To check
that a PR is the same before and after force push, you can use the following function.
Place this function in your `~/.bashrc`. In order for this function to work, both the
before and after commits must be present locally.

```
function gfd() {
local fp1=$(git show-branch --merge-base develop $1)
local fp2=$(git show-branch --merge-base develop $2)
echo fp1=$fp1
echo fp2=$fp2
diff --color=always -u -I'^[^-+]' <(git diff $fp1..$1) <(git diff $fp2..$2)
}
```
from merge conflicts to someone attempting to sneak something into the PR.
In order for `git range-diff` to work, both the before and after commits must be
present locally. See chapter [rebasing changes](#rebasing-changes)

### Finding Reviewers

Expand Down

0 comments on commit 2610df3

Please sign in to comment.