# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@octobus.net>
# Date 1685317114 -7200
# Node ID c2633c69cbe021288b1d562281cea7f3ab4384a4
# Parent  99dfe806d2f3511b0d3a84a40a0a6811291441f6
stream-clone: document the ext-stream-clone-steps.py utility extension

This extension is useful, let us clarify how to use it.

diff -r 99dfe806d2f3 -r c2633c69cbe0 tests/testlib/ext-stream-clone-steps.py
--- a/tests/testlib/ext-stream-clone-steps.py	Mon May 29 12:15:10 2023 +0200
+++ b/tests/testlib/ext-stream-clone-steps.py	Mon May 29 01:38:34 2023 +0200
@@ -1,3 +1,18 @@
+# A utility extension that help taking a break during streamclone operation
+#
+# This extension is used through two environment variable
+#
+# HG_TEST_STREAM_WALKED_FILE_1
+#
+#   path of a file created by the process generating the streaming clone when
+#   it is done gathering data and is ready to unlock the repository and move
+#   to the streaming of content.
+#
+# HG_TEST_STREAM_WALKED_FILE_2
+#
+#   path of a file to be manually created to let the process generating the
+#   streaming clone proceed to streaming file content.
+
 from mercurial import (
     encoding,
     extensions,