Patchwork [10,of,10,V10] help: add documentation about bookmark part

login
register
mail settings
Submitter Stanislau Hlebik
Date Nov. 20, 2016, 12:14 p.m.
Message ID <b46026585f5961e520c2.1479644043@dev1918.lla1.facebook.com>
Download mbox | patch
Permalink /patch/17649/
State Accepted
Headers show

Comments

Stanislau Hlebik - Nov. 20, 2016, 12:14 p.m.
# HG changeset patch
# User Stanislau Hlebik <stash@fb.com>
# Date 1479373181 28800
#      Thu Nov 17 00:59:41 2016 -0800
# Node ID b46026585f5961e520c21ea336baa7a6f68a3d85
# Parent  adbd3b69427059264d78fa8f29fa6eabcc38bf5f
help: add documentation about bookmark part

Patch

diff --git a/mercurial/help/internals/bundles.txt b/mercurial/help/internals/bundles.txt
--- a/mercurial/help/internals/bundles.txt
+++ b/mercurial/help/internals/bundles.txt
@@ -92,3 +92,32 @@ 
 ``HGS1UN`` support was added as an experimental feature in version 3.6
 (released November 2015) as part of the initial offering of the *clone
 bundles* feature.
+
+Bundle2 parts
+=============
+
+Bundle2 may contain many different pieces of information. These pieces are
+called parts.
+
+Bookmarks part
+--------------
+
+This part contains information about bookmarks. Part consists of many entries.
+Each entry describes one bookmark. Entry format:
+
+4 bytes
+  bookmark size
+1 byte
+  boolean. True if node is empty, False otherwise
+20 bytes (optional)
+  node. Present only if previous field is True
+
+Modes:
+
+1. 'ignore' - do not apply any changes to the repo, just decode the passed
+bookmarks. Will be used to list bookmarks in remote repo.
+2. 'diverge' - apply bookmark changes to the repo. Create divergent bookmarks if
+there is a non-fastforward move. Will be used during pull.
+3. 'apply' - apply bookmark changes to the repo. Overwrite current bookmark node
+if there is a non-fastforward move. Will be used during push.
+