This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9568

scmutil: improve documentation of writereporequirements()
ClosedPublic

Authored by pulkit on Dec 12 2020, 3:40 AM.

Details

Reviewers
Alphare
marmoute
Group Reviewers
hg-reviewers
Commits
rHGcb12658bf0e1: scmutil: improve documentation of writereporequirements()
Summary

This makes it easier to understand the difference between writerequires()
and writereporequirements().

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

pulkit created this revision.Dec 12 2020, 3:40 AM
pulkit updated this revision to Diff 24192.Dec 12 2020, 4:04 AM
Alphare accepted this revision.Dec 14 2020, 4:59 AM
pulkit added a comment.Dec 21 2020, 7:00 AM

Review ping for this series.

marmoute accepted this revision.Dec 22 2020, 3:27 AM
baymax updated this revision to Diff 24609.Jan 6 2021, 6:53 AM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

marmoute accepted this revision.Jan 8 2021, 1:07 PM
marmoute added a subscriber: mharbison72.Jan 8 2021, 1:43 PM

@mharbison72 any change you could queue this documentation improvement ?

pulkit added a commit: rHGcb12658bf0e1: scmutil: improve documentation of writereporequirements().Jan 13 2021, 2:40 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHGcb12658bf0e1: scmutil: improve documentation of writereporequirements() (authored by pulkit). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/scmutil.py (7 lines)

Diff 24609

mercurial/scmutil.py

def istreemanifest(repo): def istreemanifest(repo):
""" returns whether the repository is using treemanifest or not """ """ returns whether the repository is using treemanifest or not """
return requirementsmod.TREEMANIFEST_REQUIREMENT in repo.requirements return requirementsmod.TREEMANIFEST_REQUIREMENT in repo.requirements
def writereporequirements(repo, requirements=None): def writereporequirements(repo, requirements=None):
""" writes requirements for the repo to .hg/requires """ """writes requirements for the repo
Requirements are written to .hg/requires and .hg/store/requires based
on whether share-safe mode is enabled and which requirements are wdir
requirements and which are store requirements
"""
if requirements: if requirements:
repo.requirements = requirements repo.requirements = requirements
wcreq, storereq = filterrequirements(repo.requirements) wcreq, storereq = filterrequirements(repo.requirements)
if wcreq is not None: if wcreq is not None:
writerequires(repo.vfs, wcreq) writerequires(repo.vfs, wcreq)
if storereq is not None: if storereq is not None:
writerequires(repo.svfs, storereq) writerequires(repo.svfs, storereq)
elif repo.ui.configbool(b'format', b'usestore'): elif repo.ui.configbool(b'format', b'usestore'):