# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@fb.com>
# Date 2015-06-17 03:36:00
# Node ID 2fea23d035d8ec84369b51493de7cd47a3227cef
# Parent  ddb2a648fdbd89141c4088009e8ae53409d890f5

contrib: rename revsetbenchmarks.txt to 'base-revsets.txt'

We rename the file and document its purpose. We'll be introducing another file
gathering revsets useful for benchmark of the predicate themsleves in a coming
changesets.

diff --git a/contrib/revsetbenchmarks.txt b/contrib/base-revsets.txt
rename from contrib/revsetbenchmarks.txt
rename to contrib/base-revsets.txt
--- a/contrib/revsetbenchmarks.txt
+++ b/contrib/base-revsets.txt
@@ -1,3 +1,20 @@
+# Base Revsets to be used with revsetbenchmarks.py script
+#
+# The goal of this file is to gather a limited amount of revsets that allow a
+# good coverage of the internal revsets mechanisms.  Revsets included should not
+# be selected for their individual implementation, but for what they reveal of
+# the internal implementation of smartsets classes (and their interactions).
+#
+# Use and update this file when you change internal implementation of these
+# smartsets classes. Please include a comment explaining what each of your
+# addition is testing. Also check if your changes to the smartset class makes
+# some of the tests inadequate and replace them with a new one testing the same
+# behavior.
+#
+# The current content of this file is currently likely not reaching this goal
+# entirely, feel free, to audit its content and comment on each revset to
+# highlight what internal mechanisms they test.
+
 all()
 draft()
 ::tip