This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5851

scmutil: introduce a new backuppath() to replace origpath()
ClosedPublic

Authored by martinvonz on Feb 5 2019, 12:52 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG8785188d1915: scmutil: introduce a new backuppath() to replace origpath()
Summary

Unlike most functions in our codebase, origpath() takes a path that is
relative to cwd. This commit introduces a replacement for
origpath(). The new function takes a path that is relative to the repo
root. There is a lot of duplication between the two, but I intend to
remove origpath() within the next few commits, so it won't be a
maintenance burden.

origpath() is also a little weird in that it returns either a a
cwd-relative path or an absolute path. It needs to be able to return a
path outside the repo, so it makes sense that it can return an
absolute path. However, it would be simpler to always return an
absolute path. The new function does that.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

martinvonz created this revision.Feb 5 2019, 12:52 PM
martinvonz edited the summary of this revision. (Show Details)Feb 6 2019, 6:58 PM
martinvonz updated this revision to Diff 13856.
Closed by commit rHG8785188d1915: scmutil: introduce a new backuppath() to replace origpath() (authored by martinvonz). · Explain WhyFeb 6 2019, 9:02 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/scmutil.py (37 lines)

Diff 13815

mercurial/scmutil.py

"""return a vfs suitable to save 'orig' file """return a vfs suitable to save 'orig' file
return None if no special directory is configured""" return None if no special directory is configured"""
origbackuppath = ui.config('ui', 'origbackuppath') origbackuppath = ui.config('ui', 'origbackuppath')
if not origbackuppath: if not origbackuppath:
return None return None
return vfs.vfs(repo.wvfs.join(origbackuppath)) return vfs.vfs(repo.wvfs.join(origbackuppath))
def backuppath(ui, repo, filepath):
'''customize where working copy backup files (.orig files) are created
Fetch user defined path from config file: [ui] origbackuppath = <path>
Fall back to default (filepath with .orig suffix) if not specified
filepath is repo-relative
Returns a repo-relative path *or* an absolute path. The caller is thus
expected to call repo.wjoin() on the result before passing it to e.g.
util.rename().
'''
origvfs = getorigvfs(ui, repo)
if origvfs is None:
return filepath + ".orig"
origbackupdir = origvfs.dirname(filepath)
if not origvfs.isdir(origbackupdir) or origvfs.islink(origbackupdir):
ui.note(_('creating directory: %s\n') % origvfs.join(origbackupdir))
# Remove any files that conflict with the backup file's path
for f in reversed(list(util.finddirs(filepath))):
if origvfs.isfileorlink(f):
ui.note(_('removing conflicting file: %s\n')
% origvfs.join(f))
origvfs.unlink(f)
break
origvfs.makedirs(origbackupdir)
if origvfs.isdir(filepath) and not origvfs.islink(filepath):
ui.note(_('removing conflicting directory: %s\n')
% origvfs.join(filepath))
origvfs.rmtree(filepath, forcibly=True)
return origvfs.join(filepath)
def origpath(ui, repo, filepath): def origpath(ui, repo, filepath):
'''customize where .orig files are created '''customize where .orig files are created
Fetch user defined path from config file: [ui] origbackuppath = <path> Fetch user defined path from config file: [ui] origbackuppath = <path>
Fall back to default (filepath with .orig suffix) if not specified Fall back to default (filepath with .orig suffix) if not specified
''' '''
origvfs = getorigvfs(ui, repo) origvfs = getorigvfs(ui, repo)
if origvfs is None: if origvfs is None: