This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9729

patch: handle filenames with trailing spaces
ClosedPublic

Authored by spectral on Jan 12 2021, 1:33 PM.

Details

Reviewers
martinvonz
Group Reviewers
hg-reviewers
Commits
rHG416ecdaa12df: patch: handle filenames with trailing spaces
Summary

I have no idea if this is *actually* supported by the patch file format, but at
least when reading from a patch file created by running hg shelve, it is
written out such that there's a trailing space after the second (b) filename.
When we read the patch file, we remove the space before parsing the filenames,
so it doesn't end up matching the other sources of what files are in the shelve.

We observed this internally due to a wrapper around unshelve that called into
patch.changedfiles, but hg patch is able to reproduce the issue as well, so
I've included both tests.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

spectral created this revision.Jan 12 2021, 1:33 PM
martinvonz accepted this revision.Jan 12 2021, 1:53 PM
martinvonz added a subscriber: martinvonz.

I have no idea if this is *actually* supported by the patch file format,

At least Git seems to preserve the filename even if it has a trailing space.

This patch looks good to me. I'll just give others a chance to comment before I queue.

This revision is now accepted and ready to land.Jan 12 2021, 1:53 PM
spectral added a commit: rHG416ecdaa12df: patch: handle filenames with trailing spaces.Jan 13 2021, 2:41 PM
Closed by commit rHG416ecdaa12df: patch: handle filenames with trailing spaces (authored by spectral). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/patch.py (4 lines)
Mtests/test-shelve.t (23 lines)

Diff 24805

mercurial/patch.py

def readgitpatch(lr): def readgitpatch(lr):
"""extract git-style metadata about patches from <patchname>""" """extract git-style metadata about patches from <patchname>"""
# Filter patch for git information # Filter patch for git information
gp = None gp = None
gitpatches = [] gitpatches = []
for line in lr: for line in lr:
line = line.rstrip(b' \r\n') line = line.rstrip(b'\r\n')
if line.startswith(b'diff --git a/'): if line.startswith(b'diff --git a/'):
m = gitre.match(line) m = gitre.match(line)
if m: if m:
if gp: if gp:
gitpatches.append(gp) gitpatches.append(gp)
dst = m.group(2) dst = m.group(2)
gp = patchmeta(dst) gp = patchmeta(dst)
elif gp: elif gp:
context = True context = True
h = hunk(x, hunknum + 1, lr, context) h = hunk(x, hunknum + 1, lr, context)
hunknum += 1 hunknum += 1
if emitfile: if emitfile:
emitfile = False emitfile = False
yield b'file', (afile, bfile, h, gp and gp.copy() or None) yield b'file', (afile, bfile, h, gp and gp.copy() or None)
yield b'hunk', h yield b'hunk', h
elif x.startswith(b'diff --git a/'): elif x.startswith(b'diff --git a/'):
m = gitre.match(x.rstrip(b' \r\n')) m = gitre.match(x.rstrip(b'\r\n'))
if not m: if not m:
continue continue
if gitpatches is None: if gitpatches is None:
# scan whole input for git metadata # scan whole input for git metadata
gitpatches = scangitpatch(lr, x) gitpatches = scangitpatch(lr, x)
yield b'git', [ yield b'git', [
g.copy() for g in gitpatches if g.op in (b'COPY', b'RENAME') g.copy() for g in gitpatches if g.op in (b'COPY', b'RENAME')
] ]

tests/test-shelve.t

C C
record this change to 'bar2'? record this change to 'bar2'?
(enter ? for help) [Ynesfdaq?] y (enter ? for help) [Ynesfdaq?] y
-- test for --interactive --keep -- test for --interactive --keep
$ hg unshelve -i --keep $ hg unshelve -i --keep
abort: --keep on --interactive is not yet supported abort: --keep on --interactive is not yet supported
[255] [255]
$ hg update -q --clean .
Test that we can successfully shelve and unshelve a file with a trailing space
in the filename. Such filenames are supposedly unsupported on Windows, so we
wrap it in the no-windows check. Also test `hg patch` of the .patch file
produced by `hg shelve`.
#if no-windows
$ echo hi > 'my filename '
$ hg add 'my filename '
warning: filename ends with ' ', which is not allowed on Windows: 'my filename '
$ hg shelve
shelved as default-01
0 files updated, 0 files merged, 1 files removed, 0 files unresolved
$ cp .hg/shelved/default-01.patch test_patch.patch
$ hg unshelve
unshelving change 'default-01'
$ cat 'my filename '
hi
$ hg update -q --clean .
$ hg patch -p1 test_patch.patch
applying test_patch.patch
#endif