remotefilelog: add some docstring
Differential Revision: https://phab.mercurial-scm.org/D5131
--- a/hgext/remotefilelog/__init__.py Thu Oct 04 10:03:10 2018 -0400
+++ b/hgext/remotefilelog/__init__.py Wed Oct 17 09:12:29 2018 -0400
@@ -6,6 +6,17 @@
# GNU General Public License version 2 or any later version.
"""remotefilelog causes Mercurial to lazilly fetch file contents (EXPERIMENTAL)
+This extension is HIGHLY EXPERIMENTAL. There are NO BACKWARDS COMPATIBILITY
+GUARANTEES. This means that repositories created with this extension may
+only be usable with the exact version of this extension/Mercurial that was
+used. The extension attempts to enforce this in order to prevent repository
+corruption.
+
+remotefilelog works by fetching file contents lazily and storing them
+in a cache on the client rather than in revlogs. This allows enormous
+histories to be transferred only partially, making them easier to
+operate on.
+
Configs:
``packs.maxchainlen`` specifies the maximum delta chain length in pack files