Mercurial > hg-stable

changeset 20808:4c9130c7a29f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
bundle2: clarify stream parameter design in the documentation Stream level parameter have very restricted use case. Clarify why we chosen a textual format and point that applicative data goes in applicative parts.
author Pierre-Yves David <pierre-yves.david@fb.com>
date Thu, 20 Mar 2014 13:18:34 -0700
parents 91d28bd0e04e
children b93bb639451a
files mercurial/bundle2.py
diffstat 1 files changed, 7 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/bundle2.py	Tue Mar 18 20:10:33 2014 -0500
+++ b/mercurial/bundle2.py	Thu Mar 20 13:18:34 2014 -0700
@@ -48,7 +48,14 @@
 
   Special character in param name are not supported yet.
 
+  Stream parameters use a simple textual format for two main reasons:
 
+  - Stream level parameters should remains simple and we want to discourage any
+    crazy usage.
+  - Textual data allow easy human inspection of a the bundle2 header in case of
+    troubles.
+
+  Any Applicative level options MUST go into a bundle2 part instead.
 
 
 Payload part