Skip to content

[libc++] Add a merge driver that can apply clang-format #73712

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 4, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions libcxx/utils/clang-format-merge-driver.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
#!/usr/bin/env bash

# This script can be installed in .git/config to allow rebasing old patches across
# libc++'s clang-format of the whole tree. Most contributors should not require that
# since they don't have many pre-clang-format patches lying around. This script is to
# make it easier for contributors that do have such patches.
#
# The script is installed by running the following from the root of your repository:
#
# $ git config merge.libcxx-reformat.name "Run clang-format when rebasing libc++ patches"
# $ git config merge.libcxx-reformat.driver "libcxx/utils/clang-format-merge-driver.sh %O %A %B %P"
#
# This is based on https://github.com/nico/hack/blob/main/notes/auto_git_rebase_across_mechanical_changes.md.
# Many thanks to Nico Weber for paving the way here.

# Path to the file's contents at the ancestor's version.
base="$1"

# Path to the file's contents at the current version.
current="$2"

# Path to the file's contents at the other branch's version (for nonlinear histories, there might be multiple other branches).
other="$3"

# The path of the file in the repository.
path="$4"

clang-format --style=file --assume-filename="$path" < "$base" > "$base.tmp"
mv "$base.tmp" "$base"

clang-format --style=file --assume-filename="$path" < "$current" > "$current.tmp"
mv "$current.tmp" "$current"

clang-format --style=file --assume-filename="$path" < "$other" > "$other.tmp"
mv "$other.tmp" "$other"

git merge-file -Lcurrent -Lbase -Lother "$current" "$base" "$other"