# HG changeset patch
# User Ryan McElroy <rmcelroy@fb.com>
# Date 1490104242 25200
# Node ID 48b9c9ca09b745d06e07832699b082f9fe98e9e4
# Parent  d0f95ecca2ad1ab59d0dd262049a5eb1fe8fa490
localrepo: improve vfs documentation

At the beginning of March, I promised Yuya that I would follow up a comment I
made on a patch with improved documention for these vfs objects. Also hat tip
to Pierre-Yves for adding the documentation here in the first place.

diff -r d0f95ecca2ad -r 48b9c9ca09b7 mercurial/localrepo.py
--- a/mercurial/localrepo.py	Mon Mar 20 05:08:21 2017 -0700
+++ b/mercurial/localrepo.py	Tue Mar 21 06:50:42 2017 -0700
@@ -260,11 +260,13 @@
 
     def __init__(self, baseui, path, create=False):
         self.requirements = set()
-        # vfs to access the working copy
+        # wvfs: rooted at the repository root, used to access the working copy
         self.wvfs = vfsmod.vfs(path, expandpath=True, realpath=True)
-        # vfs to access the content of the repository
+        # vfs: rooted at .hg, used to access repo files outside of .hg/store
         self.vfs = None
-        # vfs to access the store part of the repository
+        # svfs: usually rooted at .hg/store, used to access repository history
+        # If this is a shared repository, this vfs may point to another
+        # repository's .hg/store directory.
         self.svfs = None
         self.root = self.wvfs.base
         self.path = self.wvfs.join(".hg")