eglot2emacs

.gitignore

emacs/
eglot/

README.md

Collecting authors with non-trivial changes

cd eglot
git filter-repo --quiet --commit-callback ../collect-emails-from-non-trivial.py \
    2> /dev/null | head -n -2 | sort -u -t$'\t' -k2,2
    > ../mailmap.txt

Now mailmap.txt can be edited, as it has in the checked-in version. The emails were adjusted to match the emails in the copyright assignment file. The following command adjusts the emails and is included in the ./eglot2emacs.sh script.

git filter-repo --mailmap ../mailmap.txt

Rewriting the repository in batch.

Read commentary in ./eglot2emacs.sh.

adjust-issue-references.py

def doit(m):
    m = re.sub(b"\r",b"",m)

    refs = []
    refverb = None
    url = "https://github.com/joaotavora/eglot/issues/"
    header = "GitHub-reference:"

    [firstline, _ , rest] = m.partition(b'\n')

    def collect_firstline_ref(match):
        nonlocal refverb
        refverb = match.group(1) or refverb
        refs.append([match.group(2), refverb])
        return b""

    def adjust_firstline(fl):
        return re.sub(b" *(Per|Fix(?:es)?|Close(?:s)?)? *#([0-9]+)(?:[,:] *)?",
                      collect_firstline_ref,
                      fl)

    rest = re.sub(b"#([0-9]+)",
              f"{url}\\1".encode(),
              rest)

    rest = rest.strip()

    def bottom_reference(p):
        verb = f"{p[1].decode().lower()} " if p[1] else ""
        return f"{header} {verb}{url}{p[0].decode()}".encode()

    last_line_is_header = bool(re.search(b"\n[A-Z][^\s:\n]*: [^:\n]*$", rest))

    return (adjust_firstline(firstline).capitalize().strip()
            + b"\n\n"
            + rest
            + b"\n"
            + (b"" if last_line_is_header else b"\n")
            + b"\n".join(map(bottom_reference, refs)))

return doit(message)

adjust-some-commits.py

if (commit.original_id in [b"fcb8ab638bf20cd51f13445bbbc3213b774333d0",
                           b"aa50b4bb9e52d15472c7a4f9c6101506dfa4f8b4",
                           b"133bee1a93d14d33e87e1646abd55a367bd52245",
                           b"badcaeca88bc0f3908b94be99d82949309c4ebb5",
                           b"a0eca3f8a7db7694006b4446390235b03ad80842"]):
    print("This commit is considered copyright exempt:: " + commit.original_id.decode())
    commit.message += b"\nCopyright-paperwork-exempt: yes\n"

collect-emails-from-non-trivial.py

if (not re.search(b"Copyright-[Pp]aperwork-[Ee]xempt:.*[Yy]es", commit.message)):
    print((commit.author_name + b"\t<" + commit.author_email + b">").decode())

eglot2emacs.sh

# This code merges `eglot.el` from joaotavora/eglot to upstream
# `emacs.git` master branch.
#
# It does the following things:
#
# - Move eglot.el to lisp/progmodes/eglot.el
#
# - Preserve complete history from original repo for the file
#
# - Edit commit messages to append URLs for all mentioned issues and
#   PRs to individual commit message

# Dependencies required
#
# - https://github.com/newren/git-filter-repo
#    nix shell nixpkgs#git-filter-repo
#    arch: pacman -S git-filter-repo
# - git

# While made by order, it is perfect example and suitable to rearrange
# code while preserving as well as modifying git history
# programmatically.

# Hope it helps!
#
#
# Repo will be cloned in this directory if they don't exist directory.
# No repo update will be performed automatically.
#
# It is recommended that the Emacs repo be cloned here under the
# scratch/eglot2emacs branch.  This can be done by moving on to the
# principal emacs worktree and typing:
#
#   git worktree add /path-to-this-files-directory/emacs scratch/eglot2emacs
#
# If (when) things go sour, this normally helps:
#
#   rm -rf eglot # will be recloned
#   cd emacs
#   git merge --abort
#   cd ../
#
# clone repos
test -d eglot/.git || git clone https://github.com/joaotavora/eglot.git
test -d emacs/.git || git clone -b master git://git.sv.gnu.org/emacs.git

# filter eglot to keep only eglot.el.  This destroys the current
# worktree of the repo.
#
# move eglot.el to lisp/progmodes/eglot.el -> This makes history file
# specific and everything makes find+replace in commit messages

(
    cd eglot

    git filter-repo -f --message-callback ../adjust-issue-references.py

    git filter-repo -f --commit-callback ../adjust-some-commits.py

    git filter-repo -f --mailmap ../mailmap.txt

    git filter-repo -f --to-subdirectory-filter lisp/progmodes/ --path eglot.el
)

(
    cd emacs
    git reset --hard origin/master
    # add filtered eglot as upstream
    git remote add eglot2emacs-filtered-eglot ../eglot/
    git fetch eglot2emacs-filtered-eglot master
    git merge remotes/eglot2emacs-filtered-eglot/master --allow-unrelated-histories --no-commit
    # make a commit
    git commit -m "; Merge from https://github.com/joaotavora/eglot"
)

mailmap.txt

Alan Zimmerman	<[email protected]>
Alex Branham	<[email protected]> Alex Branham <[email protected]>
Andrii Kolomoiets	<[email protected]>
Augusto Stoffel	<[email protected]> <[email protected]>
Basil L. Contovounesios	<[email protected]>
Brian Cully	<[email protected]>
Brian Leung	 <[email protected]> <[email protected]>
<[email protected]> <[email protected]>
<[email protected]> <[email protected]>
Christian Garbs	<[email protected]>
Damien Merenne	<[email protected]>
Dan Davison	<[email protected]>
Dmitry Gutov	<[email protected]>
Evgeni Kolev	<[email protected]>
Felicián Németh	<[email protected]>
Fredrik Bergroth	<[email protected]>
Ingo Lohmar	<[email protected]> <[email protected]>
James Nguyen	<[email protected]>
Jim Porter	<[email protected]> <[email protected]>
Josh Elsasser	<[email protected]>
João Távora	<[email protected]>
Jürgen Hötzel	<[email protected]>
Manuel Uberti	<[email protected]> <[email protected]>
Michael Livshin	<[email protected]> <[email protected]>
Michal Krzywkowski	<[email protected]>
Mohsin Kaleem	<[email protected]>
Omar Polo	<[email protected]>
Philip Kaludercic	<[email protected]> Philip K	<[email protected]>
Philipp Stephani	<[email protected]>
Rudolf Schlatte	<[email protected]>
Stefan Kangas	 <[email protected]> <[email protected]>
Stefan Monnier	<[email protected]>
Stephen Leake	<[email protected]> <[email protected]>
Steve Purcell	<[email protected]>
Theodor Thornhill	<[email protected]> <[email protected]>
<[email protected]> <[email protected]>
Tom Tromey	<[email protected]>
Trevor Murphy	<[email protected]>
Yuan Fu	<[email protected]>


# These authors have only trivial commits, but are not marked
# jgart	<[email protected]>
# Sergey Kostyaev	<[email protected]>
# brotzeit	<[email protected]>
# Fangrui Song	<[email protected]>