Skip to content

Improve misleading passage about custom merge drivers

Hubert Maraszek requested to merge hmaraszek-master-patch-55661 into master

What does this MR do?

I am working with a customer (internal) who's interested in skipping certain files in a merge. They have found the documentation about custom merge drivers, which suggests that it can do exactly what they are looking for. This advice is misleading, because some types of merges do not invoke a custom merge driver at all; they are only invoked in case of a merge conflict that cannot be automatically resolved, so it will not be used in for example a fast-forward merge, or a merge where the file changed on only one of the branches.

There are many examples of people misunderstanding this Git feature in a similar way:

https://stackoverflow.com/questions/68643219/merge-drivers-dont-work-when-merging-into-default-branch https://www.reddit.com/r/git/comments/51jgu4/help_gitattributes_ignored_when_merging/ https://forum.gitlab.com/t/gitlab-enable-merge-driver-and-configure-gitattributes-exclude-file-folders-on-merge-request/8254

We shouldn't perpetuate this misconception.

Related issues

#18830 (closed)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

Merge request reports

Loading