[PATCH] localrepo: improve vfs documentation

[Jun Wu]

Excerpts from Ryan McElroy's message of 2017-03-20 19:07:18 -0700:
> # HG changeset patch
> # User Ryan McElroy <rmcelroy at fb.com>
> # Date 1490060600 25200
> #      Mon Mar 20 18:43:20 2017 -0700
> # Node ID 8fbdaf1533bb20cb471679be6ab2dc799fd7e634
> # Parent  2dc8b65b19a9d4bd14e8e935a27e29c91be1f6ec
> 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 --git a/mercurial/localrepo.py b/mercurial/localrepo.py
> --- a/mercurial/localrepo.py
> +++ b/mercurial/localrepo.py
> @@ -259,11 +259,11 @@ class localrepository(object):
>  
>      def __init__(self, baseui, path, create=False):
>          self.requirements = set()
> -        # vfs to access the working copy
> +        # vfs 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
> +        # vfs rooted at .hg/store used to access repository history

If share is enabled, it may be something else.

>          self.svfs = None
>          self.root = self.wvfs.base
>          self.path = self.wvfs.join(".hg")