Patchwork [02,of,13,sparse,V2] sparse: expand module docstring

login
register
mail settings
Submitter Gregory Szorc
Date July 6, 2017, 7:36 p.m.
Message ID <73fb571b44782b7bcb51.1499369788@ubuntu-vm-main>
Download mbox | patch
Permalink /patch/22030/
State Accepted
Headers show

Comments

Gregory Szorc - July 6, 2017, 7:36 p.m.
# HG changeset patch
# User Gregory Szorc <gregory.szorc@gmail.com>
# Date 1498930563 25200
#      Sat Jul 01 10:36:03 2017 -0700
# Node ID 73fb571b44782b7bcb5142606b3ae69ec420341c
# Parent  aa0533ab478446530a11daee40e60955f36d5eed
sparse: expand module docstring

Clarify lack of BC guarantees. And say a bit more about the extension.

Patch

diff --git a/hgext/sparse.py b/hgext/sparse.py
--- a/hgext/sparse.py
+++ b/hgext/sparse.py
@@ -6,6 +6,17 @@ 
 # GNU General Public License version 2 or any later version.
 
 """allow sparse checkouts of the working directory (EXPERIMENTAL)
+
+(This extension is not yet protected by backwards compatibility
+guarantees. Any aspect may break in future releases until this
+notice is removed.)
+
+This extension allows the working directory to only consist of a
+subset of files for the revision. This allows specific files or
+directories to be explicitly included or excluded. Many repository
+operations have performance proportional to the number of files in
+the working directory. So only realizing a subset of files in the
+working directory can improve performance.
 """
 
 from __future__ import absolute_import