Patchwork D9568: scmutil: improve documentation of writereporequirements()

login
register
mail settings
Submitter phabricator
Date Dec. 12, 2020, 8:40 a.m.
Message ID <differential-rev-PHID-DREV-gkc7konhqgh5rbl647em-req@mercurial-scm.org>
Download mbox | patch
Permalink /patch/47866/
State Superseded
Headers show

Comments

phabricator - Dec. 12, 2020, 8:40 a.m.
pulkit created this revision.
Herald added a reviewer: hg-reviewers.
Herald added a subscriber: mercurial-patches.

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

REPOSITORY
  rHG Mercurial

BRANCH
  default

REVISION DETAIL
  https://phab.mercurial-scm.org/D9568

AFFECTED FILES
  mercurial/scmutil.py

CHANGE DETAILS




To: pulkit, #hg-reviewers
Cc: mercurial-patches, mercurial-devel

Patch

diff --git a/mercurial/scmutil.py b/mercurial/scmutil.py
--- a/mercurial/scmutil.py
+++ b/mercurial/scmutil.py
@@ -1572,7 +1572,12 @@ 
 
 
 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:
         repo.requirements = requirements
     wcreq, storereq = filterrequirements(repo.requirements)