# HG changeset patch
# User Augie Fackler <augie@google.com>
# Date 2018-10-17 13:12:29
# Node ID b35a096b9bff05f1c9a03dfcfba11c0cd07351ee
# Parent  466dd4d70bfff5e19aeb4a0da9be75fc469e6d1b

remotefilelog: add some docstring

Differential Revision: https://phab.mercurial-scm.org/D5131

diff --git a/hgext/remotefilelog/__init__.py b/hgext/remotefilelog/__init__.py
--- a/hgext/remotefilelog/__init__.py
+++ b/hgext/remotefilelog/__init__.py
@@ -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