Fossil SCM

Add documentation on the private branch sync feature.

drh 2011-02-28 15:01 trunk
Commit c97c6aa45f88facf842816345e6f2c44c18a42e8
--- www/faq.tcl
+++ www/faq.tcl
@@ -113,10 +113,12 @@
113113
final merge operation will appear in other repositories. It will seem
114114
as if all the changes that occurred on your private branch occurred in
115115
a single check-in.
116116
Of course, you can also keep your branch private forever simply
117117
by not merging the changes in the private branch back into the trunk.
118
+
119
+ [./private.wiki | Additional information]
118120
}
119121
120122
faq {
121123
How can I delete inappropriate content from my fossil repository?
122124
} {
123125
--- www/faq.tcl
+++ www/faq.tcl
@@ -113,10 +113,12 @@
113 final merge operation will appear in other repositories. It will seem
114 as if all the changes that occurred on your private branch occurred in
115 a single check-in.
116 Of course, you can also keep your branch private forever simply
117 by not merging the changes in the private branch back into the trunk.
 
 
118 }
119
120 faq {
121 How can I delete inappropriate content from my fossil repository?
122 } {
123
--- www/faq.tcl
+++ www/faq.tcl
@@ -113,10 +113,12 @@
113 final merge operation will appear in other repositories. It will seem
114 as if all the changes that occurred on your private branch occurred in
115 a single check-in.
116 Of course, you can also keep your branch private forever simply
117 by not merging the changes in the private branch back into the trunk.
118
119 [./private.wiki | Additional information]
120 }
121
122 faq {
123 How can I delete inappropriate content from my fossil repository?
124 } {
125
+3 -1
--- www/faq.wiki
+++ www/faq.wiki
@@ -114,11 +114,13 @@
114114
then merge your private branch back into the trunk and push. Only the
115115
final merge operation will appear in other repositories. It will seem
116116
as if all the changes that occurred on your private branch occurred in
117117
a single check-in.
118118
Of course, you can also keep your branch private forever simply
119
-by not merging the changes in the private branch back into the trunk.</blockquote></li>
119
+by not merging the changes in the private branch back into the trunk.
120
+
121
+[./private.wiki | Additional information]</blockquote></li>
120122
121123
<a name="q6"></a>
122124
<p><b>(6) How can I delete inappropriate content from my fossil repository?</b></p>
123125
124126
<blockquote>See the article on [./shunning.wiki | "shunning"] for details.</blockquote></li>
125127
--- www/faq.wiki
+++ www/faq.wiki
@@ -114,11 +114,13 @@
114 then merge your private branch back into the trunk and push. Only the
115 final merge operation will appear in other repositories. It will seem
116 as if all the changes that occurred on your private branch occurred in
117 a single check-in.
118 Of course, you can also keep your branch private forever simply
119 by not merging the changes in the private branch back into the trunk.</blockquote></li>
 
 
120
121 <a name="q6"></a>
122 <p><b>(6) How can I delete inappropriate content from my fossil repository?</b></p>
123
124 <blockquote>See the article on [./shunning.wiki | "shunning"] for details.</blockquote></li>
125
--- www/faq.wiki
+++ www/faq.wiki
@@ -114,11 +114,13 @@
114 then merge your private branch back into the trunk and push. Only the
115 final merge operation will appear in other repositories. It will seem
116 as if all the changes that occurred on your private branch occurred in
117 a single check-in.
118 Of course, you can also keep your branch private forever simply
119 by not merging the changes in the private branch back into the trunk.
120
121 [./private.wiki | Additional information]</blockquote></li>
122
123 <a name="q6"></a>
124 <p><b>(6) How can I delete inappropriate content from my fossil repository?</b></p>
125
126 <blockquote>See the article on [./shunning.wiki | "shunning"] for details.</blockquote></li>
127
--- www/mkindex.tcl
+++ www/mkindex.tcl
@@ -25,10 +25,11 @@
2525
index.wiki {Home Page}
2626
inout.wiki {Import And Export To And From Git}
2727
makefile.wiki {The Fossil Build Process}
2828
password.wiki {Password Management And Authentication}
2929
pop.wiki {Principles Of Operations}
30
+ private.wiki {Creating, Syncing, and Deleting Private Branches}
3031
qandc.wiki {Questions And Criticisms}
3132
quickstart.wiki {Fossil Quick Start Guide}
3233
quotes.wiki
3334
{Quotes: What People Are Saying About Fossil, Git, and DVCSes in General}
3435
../test/release-checklist.wiki {Pre-Release Testing Checklist}
3536
--- www/mkindex.tcl
+++ www/mkindex.tcl
@@ -25,10 +25,11 @@
25 index.wiki {Home Page}
26 inout.wiki {Import And Export To And From Git}
27 makefile.wiki {The Fossil Build Process}
28 password.wiki {Password Management And Authentication}
29 pop.wiki {Principles Of Operations}
 
30 qandc.wiki {Questions And Criticisms}
31 quickstart.wiki {Fossil Quick Start Guide}
32 quotes.wiki
33 {Quotes: What People Are Saying About Fossil, Git, and DVCSes in General}
34 ../test/release-checklist.wiki {Pre-Release Testing Checklist}
35
--- www/mkindex.tcl
+++ www/mkindex.tcl
@@ -25,10 +25,11 @@
25 index.wiki {Home Page}
26 inout.wiki {Import And Export To And From Git}
27 makefile.wiki {The Fossil Build Process}
28 password.wiki {Password Management And Authentication}
29 pop.wiki {Principles Of Operations}
30 private.wiki {Creating, Syncing, and Deleting Private Branches}
31 qandc.wiki {Questions And Criticisms}
32 quickstart.wiki {Fossil Quick Start Guide}
33 quotes.wiki
34 {Quotes: What People Are Saying About Fossil, Git, and DVCSes in General}
35 ../test/release-checklist.wiki {Pre-Release Testing Checklist}
36
--- www/permutedindex.wiki
+++ www/permutedindex.wiki
@@ -6,10 +6,11 @@
66
Of Fossil</a></li>
77
<li><a href="copyright-release.html">Agreement &#151; Contributor License</a></li>
88
<li><a href="delta_encoder_algorithm.wiki">Algorithm &#151; Fossil Delta Encoding</a></li>
99
<li><a href="faq.wiki">Asked Questions &#151; Frequently</a></li>
1010
<li><a href="password.wiki">Authentication &#151; Password Management And</a></li>
11
+<li><a href="private.wiki">Branches &#151; Creating, Syncing, and Deleting Private</a></li>
1112
<li><a href="branching.wiki">Branching, Forking, Merging, and Tagging</a></li>
1213
<li><a href="bugtheory.wiki">Bug Tracking In Fossil</a></li>
1314
<li><a href="makefile.wiki">Build Process &#151; The Fossil</a></li>
1415
<li><a href="build.wiki">Building and Installing Fossil</a></li>
1516
<li><a href="checkin_names.wiki">Checkin And Version Names</a></li>
@@ -21,14 +22,16 @@
2122
<li><a href="server.wiki">Configure A Fossil Server &#151; How To</a></li>
2223
<li><a href="shunning.wiki">Content From Fossil &#151; Shunning: Deleting</a></li>
2324
<li><a href="contribute.wiki">Contributing Code or Documentation To The Fossil Project</a></li>
2425
<li><a href="copyright-release.html">Contributor License Agreement</a></li>
2526
<li><a href="concepts.wiki">Core Concepts &#151; Fossil</a></li>
27
+<li><a href="private.wiki">Creating, Syncing, and Deleting Private Branches</a></li>
2628
<li><a href="qandc.wiki">Criticisms &#151; Questions And</a></li>
2729
<li><a href="custom_ticket.wiki">Customizing The Ticket System</a></li>
2830
<li><a href="tech_overview.wiki">Databases Used By Fossil &#151; SQLite</a></li>
2931
<li><a href="shunning.wiki">Deleting Content From Fossil &#151; Shunning:</a></li>
32
+<li><a href="private.wiki">Deleting Private Branches &#151; Creating, Syncing, and</a></li>
3033
<li><a href="delta_encoder_algorithm.wiki">Delta Encoding Algorithm &#151; Fossil</a></li>
3134
<li><a href="delta_format.wiki">Delta Format &#151; Fossil</a></li>
3235
<li><a href="tech_overview.wiki">Design And Implementation Of Fossil &#151; A Technical Overview Of The</a></li>
3336
<li><a href="theory1.wiki">Design Of The Fossil DVCS &#151; Thoughts On The</a></li>
3437
<li><a href="embeddeddoc.wiki">Documentation &#151; Embedded Project</a></li>
@@ -79,10 +82,11 @@
7982
<li><a href="password.wiki">Password Management And Authentication</a></li>
8083
<li><a href="quotes.wiki">People Are Saying About Fossil, Git, and DVCSes in General &#151; Quotes: What</a></li>
8184
<li><a href="stats.wiki">Performance Statistics</a></li>
8285
<li><a href="../test/release-checklist.wiki">Pre-Release Testing Checklist</a></li>
8386
<li><a href="pop.wiki">Principles Of Operations</a></li>
87
+<li><a href="private.wiki">Private Branches &#151; Creating, Syncing, and Deleting</a></li>
8488
<li><a href="makefile.wiki">Process &#151; The Fossil Build</a></li>
8589
<li><a href="contribute.wiki">Project &#151; Contributing Code or Documentation To The Fossil</a></li>
8690
<li><a href="embeddeddoc.wiki">Project Documentation &#151; Embedded</a></li>
8791
<li><a href="sync.wiki">Protocol &#151; The Fossil Sync</a></li>
8892
<li><a href="faq.wiki">Questions &#151; Frequently Asked</a></li>
@@ -100,10 +104,11 @@
100104
<li><a href="tech_overview.wiki">SQLite Databases Used By Fossil</a></li>
101105
<li><a href="quickstart.wiki">Start Guide &#151; Fossil Quick</a></li>
102106
<li><a href="stats.wiki">Statistics &#151; Performance</a></li>
103107
<li><a href="style.wiki">Style Guidelines &#151; Source Code</a></li>
104108
<li><a href="sync.wiki">Sync Protocol &#151; The Fossil</a></li>
109
+<li><a href="private.wiki">Syncing, and Deleting Private Branches &#151; Creating,</a></li>
105110
<li><a href="custom_ticket.wiki">System &#151; Customizing The Ticket</a></li>
106111
<li><a href="branching.wiki">Tagging &#151; Branching, Forking, Merging, and</a></li>
107112
<li><a href="tech_overview.wiki">Technical Overview Of The Design And Implementation Of Fossil &#151; A</a></li>
108113
<li><a href="../test/release-checklist.wiki">Testing Checklist &#151; Pre-Release</a></li>
109114
<li><a href="makefile.wiki">The Fossil Build Process</a></li>
110115
111116
ADDED www/private.wiki
--- www/permutedindex.wiki
+++ www/permutedindex.wiki
@@ -6,10 +6,11 @@
6 Of Fossil</a></li>
7 <li><a href="copyright-release.html">Agreement &#151; Contributor License</a></li>
8 <li><a href="delta_encoder_algorithm.wiki">Algorithm &#151; Fossil Delta Encoding</a></li>
9 <li><a href="faq.wiki">Asked Questions &#151; Frequently</a></li>
10 <li><a href="password.wiki">Authentication &#151; Password Management And</a></li>
 
11 <li><a href="branching.wiki">Branching, Forking, Merging, and Tagging</a></li>
12 <li><a href="bugtheory.wiki">Bug Tracking In Fossil</a></li>
13 <li><a href="makefile.wiki">Build Process &#151; The Fossil</a></li>
14 <li><a href="build.wiki">Building and Installing Fossil</a></li>
15 <li><a href="checkin_names.wiki">Checkin And Version Names</a></li>
@@ -21,14 +22,16 @@
21 <li><a href="server.wiki">Configure A Fossil Server &#151; How To</a></li>
22 <li><a href="shunning.wiki">Content From Fossil &#151; Shunning: Deleting</a></li>
23 <li><a href="contribute.wiki">Contributing Code or Documentation To The Fossil Project</a></li>
24 <li><a href="copyright-release.html">Contributor License Agreement</a></li>
25 <li><a href="concepts.wiki">Core Concepts &#151; Fossil</a></li>
 
26 <li><a href="qandc.wiki">Criticisms &#151; Questions And</a></li>
27 <li><a href="custom_ticket.wiki">Customizing The Ticket System</a></li>
28 <li><a href="tech_overview.wiki">Databases Used By Fossil &#151; SQLite</a></li>
29 <li><a href="shunning.wiki">Deleting Content From Fossil &#151; Shunning:</a></li>
 
30 <li><a href="delta_encoder_algorithm.wiki">Delta Encoding Algorithm &#151; Fossil</a></li>
31 <li><a href="delta_format.wiki">Delta Format &#151; Fossil</a></li>
32 <li><a href="tech_overview.wiki">Design And Implementation Of Fossil &#151; A Technical Overview Of The</a></li>
33 <li><a href="theory1.wiki">Design Of The Fossil DVCS &#151; Thoughts On The</a></li>
34 <li><a href="embeddeddoc.wiki">Documentation &#151; Embedded Project</a></li>
@@ -79,10 +82,11 @@
79 <li><a href="password.wiki">Password Management And Authentication</a></li>
80 <li><a href="quotes.wiki">People Are Saying About Fossil, Git, and DVCSes in General &#151; Quotes: What</a></li>
81 <li><a href="stats.wiki">Performance Statistics</a></li>
82 <li><a href="../test/release-checklist.wiki">Pre-Release Testing Checklist</a></li>
83 <li><a href="pop.wiki">Principles Of Operations</a></li>
 
84 <li><a href="makefile.wiki">Process &#151; The Fossil Build</a></li>
85 <li><a href="contribute.wiki">Project &#151; Contributing Code or Documentation To The Fossil</a></li>
86 <li><a href="embeddeddoc.wiki">Project Documentation &#151; Embedded</a></li>
87 <li><a href="sync.wiki">Protocol &#151; The Fossil Sync</a></li>
88 <li><a href="faq.wiki">Questions &#151; Frequently Asked</a></li>
@@ -100,10 +104,11 @@
100 <li><a href="tech_overview.wiki">SQLite Databases Used By Fossil</a></li>
101 <li><a href="quickstart.wiki">Start Guide &#151; Fossil Quick</a></li>
102 <li><a href="stats.wiki">Statistics &#151; Performance</a></li>
103 <li><a href="style.wiki">Style Guidelines &#151; Source Code</a></li>
104 <li><a href="sync.wiki">Sync Protocol &#151; The Fossil</a></li>
 
105 <li><a href="custom_ticket.wiki">System &#151; Customizing The Ticket</a></li>
106 <li><a href="branching.wiki">Tagging &#151; Branching, Forking, Merging, and</a></li>
107 <li><a href="tech_overview.wiki">Technical Overview Of The Design And Implementation Of Fossil &#151; A</a></li>
108 <li><a href="../test/release-checklist.wiki">Testing Checklist &#151; Pre-Release</a></li>
109 <li><a href="makefile.wiki">The Fossil Build Process</a></li>
110
111 DDED www/private.wiki
--- www/permutedindex.wiki
+++ www/permutedindex.wiki
@@ -6,10 +6,11 @@
6 Of Fossil</a></li>
7 <li><a href="copyright-release.html">Agreement &#151; Contributor License</a></li>
8 <li><a href="delta_encoder_algorithm.wiki">Algorithm &#151; Fossil Delta Encoding</a></li>
9 <li><a href="faq.wiki">Asked Questions &#151; Frequently</a></li>
10 <li><a href="password.wiki">Authentication &#151; Password Management And</a></li>
11 <li><a href="private.wiki">Branches &#151; Creating, Syncing, and Deleting Private</a></li>
12 <li><a href="branching.wiki">Branching, Forking, Merging, and Tagging</a></li>
13 <li><a href="bugtheory.wiki">Bug Tracking In Fossil</a></li>
14 <li><a href="makefile.wiki">Build Process &#151; The Fossil</a></li>
15 <li><a href="build.wiki">Building and Installing Fossil</a></li>
16 <li><a href="checkin_names.wiki">Checkin And Version Names</a></li>
@@ -21,14 +22,16 @@
22 <li><a href="server.wiki">Configure A Fossil Server &#151; How To</a></li>
23 <li><a href="shunning.wiki">Content From Fossil &#151; Shunning: Deleting</a></li>
24 <li><a href="contribute.wiki">Contributing Code or Documentation To The Fossil Project</a></li>
25 <li><a href="copyright-release.html">Contributor License Agreement</a></li>
26 <li><a href="concepts.wiki">Core Concepts &#151; Fossil</a></li>
27 <li><a href="private.wiki">Creating, Syncing, and Deleting Private Branches</a></li>
28 <li><a href="qandc.wiki">Criticisms &#151; Questions And</a></li>
29 <li><a href="custom_ticket.wiki">Customizing The Ticket System</a></li>
30 <li><a href="tech_overview.wiki">Databases Used By Fossil &#151; SQLite</a></li>
31 <li><a href="shunning.wiki">Deleting Content From Fossil &#151; Shunning:</a></li>
32 <li><a href="private.wiki">Deleting Private Branches &#151; Creating, Syncing, and</a></li>
33 <li><a href="delta_encoder_algorithm.wiki">Delta Encoding Algorithm &#151; Fossil</a></li>
34 <li><a href="delta_format.wiki">Delta Format &#151; Fossil</a></li>
35 <li><a href="tech_overview.wiki">Design And Implementation Of Fossil &#151; A Technical Overview Of The</a></li>
36 <li><a href="theory1.wiki">Design Of The Fossil DVCS &#151; Thoughts On The</a></li>
37 <li><a href="embeddeddoc.wiki">Documentation &#151; Embedded Project</a></li>
@@ -79,10 +82,11 @@
82 <li><a href="password.wiki">Password Management And Authentication</a></li>
83 <li><a href="quotes.wiki">People Are Saying About Fossil, Git, and DVCSes in General &#151; Quotes: What</a></li>
84 <li><a href="stats.wiki">Performance Statistics</a></li>
85 <li><a href="../test/release-checklist.wiki">Pre-Release Testing Checklist</a></li>
86 <li><a href="pop.wiki">Principles Of Operations</a></li>
87 <li><a href="private.wiki">Private Branches &#151; Creating, Syncing, and Deleting</a></li>
88 <li><a href="makefile.wiki">Process &#151; The Fossil Build</a></li>
89 <li><a href="contribute.wiki">Project &#151; Contributing Code or Documentation To The Fossil</a></li>
90 <li><a href="embeddeddoc.wiki">Project Documentation &#151; Embedded</a></li>
91 <li><a href="sync.wiki">Protocol &#151; The Fossil Sync</a></li>
92 <li><a href="faq.wiki">Questions &#151; Frequently Asked</a></li>
@@ -100,10 +104,11 @@
104 <li><a href="tech_overview.wiki">SQLite Databases Used By Fossil</a></li>
105 <li><a href="quickstart.wiki">Start Guide &#151; Fossil Quick</a></li>
106 <li><a href="stats.wiki">Statistics &#151; Performance</a></li>
107 <li><a href="style.wiki">Style Guidelines &#151; Source Code</a></li>
108 <li><a href="sync.wiki">Sync Protocol &#151; The Fossil</a></li>
109 <li><a href="private.wiki">Syncing, and Deleting Private Branches &#151; Creating,</a></li>
110 <li><a href="custom_ticket.wiki">System &#151; Customizing The Ticket</a></li>
111 <li><a href="branching.wiki">Tagging &#151; Branching, Forking, Merging, and</a></li>
112 <li><a href="tech_overview.wiki">Technical Overview Of The Design And Implementation Of Fossil &#151; A</a></li>
113 <li><a href="../test/release-checklist.wiki">Testing Checklist &#151; Pre-Release</a></li>
114 <li><a href="makefile.wiki">The Fossil Build Process</a></li>
115
116 DDED www/private.wiki
--- a/www/private.wiki
+++ b/www/private.wiki
@@ -0,0 +1,52 @@
1
+<title>Private Branches</title>
2
+
3
+d<title>Private Branches</title>
4
+
5
+By default, everything you check into a Fossil repositoBy default, everything you check into a Fossil repository is shared
6
+to all clones of that repository. In Fossil, you don't push and pull
7
+individual branches; you push and pull everything all at once.
8
+
9
+But sometimes users want to keep some private work that is not
10
+shared with others. This might be a preliminary or experimental change
11
+that needs further refinement before it is shared and which might never
12
+be shared at all. To do this in Fossil, simply commit the change with
13
+the --privblockquote></blockquote>
14
+
15
+The --private option causes Fossil to put the check-in in a new branch
16
+named "private". That branch will not participate in of the changes associated with
17
+the private branch are now folded into the public branch and are hence
18
+visi Furthermore,
19
+you have to enable g the <code>fossil pulishthe "x" cah using the <code>fossil publish</code>
20
+command. However, there is no way to convert a private branch created the one local
21
+repository where it was created. Note that you only use the --private
22
+option for the first check-in that creates the private branch.
23
+Additional eckins into the private branch remain private automatically.
24
+
25
+<h2>Publishing Private Changes</h2>
26
+
27
+After additional work, one might desire to publish the changes associated. (Title>
28
+
29
+By default, everything you c<title>Private Branches</title>
30
+
31
+tused fortes the private b, a separate
32
+control artifact to apply the <code>+close</code> tag is created and added to
33
+the repository during the commitA private branch created with Fossil version 1.30 or newer can also be
34
+convertedusly
35
+push are now folded inyou c<title>Private Branches</title>
36
+
37
+tused fortes the private b, a separate
38
+control artifact to apply the <code>+close</code> tag is created and added to
39
+the repository during the commit process. Mawindows laptop,
40
+your le</c
41
+generate a reference and generate
42
+(a "phantom")in of the changes associated with
43
+the private branch are now folded into the public branch and are hence
44
+visible to other users of the project.
45
+
46
+A drivate branch created withlrivate branch created with Fossil version 1.30 or newerT also be
47
+converted into a public branch using the <code>fossil publish</code>
48
+commandignored fortes the private b -- or the
49
+private branch remain pri include a
50
+<code>ges</h2>
51
+
52
+After ad
--- a/www/private.wiki
+++ b/www/private.wiki
@@ -0,0 +1,52 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
--- a/www/private.wiki
+++ b/www/private.wiki
@@ -0,0 +1,52 @@
1 <title>Private Branches</title>
2
3 d<title>Private Branches</title>
4
5 By default, everything you check into a Fossil repositoBy default, everything you check into a Fossil repository is shared
6 to all clones of that repository. In Fossil, you don't push and pull
7 individual branches; you push and pull everything all at once.
8
9 But sometimes users want to keep some private work that is not
10 shared with others. This might be a preliminary or experimental change
11 that needs further refinement before it is shared and which might never
12 be shared at all. To do this in Fossil, simply commit the change with
13 the --privblockquote></blockquote>
14
15 The --private option causes Fossil to put the check-in in a new branch
16 named "private". That branch will not participate in of the changes associated with
17 the private branch are now folded into the public branch and are hence
18 visi Furthermore,
19 you have to enable g the <code>fossil pulishthe "x" cah using the <code>fossil publish</code>
20 command. However, there is no way to convert a private branch created the one local
21 repository where it was created. Note that you only use the --private
22 option for the first check-in that creates the private branch.
23 Additional eckins into the private branch remain private automatically.
24
25 <h2>Publishing Private Changes</h2>
26
27 After additional work, one might desire to publish the changes associated. (Title>
28
29 By default, everything you c<title>Private Branches</title>
30
31 tused fortes the private b, a separate
32 control artifact to apply the <code>+close</code> tag is created and added to
33 the repository during the commitA private branch created with Fossil version 1.30 or newer can also be
34 convertedusly
35 push are now folded inyou c<title>Private Branches</title>
36
37 tused fortes the private b, a separate
38 control artifact to apply the <code>+close</code> tag is created and added to
39 the repository during the commit process. Mawindows laptop,
40 your le</c
41 generate a reference and generate
42 (a "phantom")in of the changes associated with
43 the private branch are now folded into the public branch and are hence
44 visible to other users of the project.
45
46 A drivate branch created withlrivate branch created with Fossil version 1.30 or newerT also be
47 converted into a public branch using the <code>fossil publish</code>
48 commandignored fortes the private b -- or the
49 private branch remain pri include a
50 <code>ges</h2>
51
52 After ad

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button