Fossil SCM

Additional documentation, especially notes on how to contribute code or documentation to Fossil.

drh 2011-02-18 00:52 trunk
Commit 98f1131c0d8059d0818ca97258fe94cc36c6c4c3
Parent 252e83d9526da79…
7 files changed +2 -1 +7 +53 +2 +4 +15 +56
~ www/build.wiki + www/checkin.wiki + www/contribute.wiki ~ www/index.wiki ~ www/mkindex.tcl ~ www/permutedindex.wiki + www/style.wiki
M www/build.wiki
+2 -1
--- www/build.wiki
+++ www/build.wiki
@@ -70,11 +70,12 @@
7070
7171
 <h2>3.0 Installing</h2>
7272
7373
 <ol>
7474
 <li value="9">
75
-<p>The finished binary is named "fossil". Put this binary in a
75
+<p>The finished binary is named "fossil" (or "fossil.exe" on windows).
76
+Put this binary in a
7677
 directory that is somewhere on your PATH environment variable.
7778
 It does not matter where.</p>
7879
7980
 <li>
8081
 <p><b>(Optional:)</b>
8182
8283
ADDED www/checkin.wiki
8384
ADDED www/contribute.wiki
--- www/build.wiki
+++ www/build.wiki
@@ -70,11 +70,12 @@
70
71 <h2>3.0 Installing</h2>
72
73 <ol>
74 <li value="9">
75 <p>The finished binary is named "fossil". Put this binary in a
 
76 directory that is somewhere on your PATH environment variable.
77 It does not matter where.</p>
78
79 <li>
80 <p><b>(Optional:)</b>
81
82 DDED www/checkin.wiki
83 DDED www/contribute.wiki
--- www/build.wiki
+++ www/build.wiki
@@ -70,11 +70,12 @@
70
71 <h2>3.0 Installing</h2>
72
73 <ol>
74 <li value="9">
75 <p>The finished binary is named "fossil" (or "fossil.exe" on windows).
76 Put this binary in a
77 directory that is somewhere on your PATH environment variable.
78 It does not matter where.</p>
79
80 <li>
81 <p><b>(Optional:)</b>
82
83 DDED www/checkin.wiki
84 DDED www/contribute.wiki
A www/checkin.wiki
+7
--- a/www/checkin.wiki
+++ b/www/checkin.wiki
@@ -0,0 +1,7 @@
1
+<title>Checkin Checklist</title>
2
+
3
+Before every checkins/h2>
4
+ <li> All changes comply no stray changes
5
+
6
+ 2Before every cu> run the following checklist prior to <u>e
7
+ 4. The checkin will not cause a uninten"Autosync" is enabled &ra
--- a/www/checkin.wiki
+++ b/www/checkin.wiki
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
--- a/www/checkin.wiki
+++ b/www/checkin.wiki
@@ -0,0 +1,7 @@
1 <title>Checkin Checklist</title>
2
3 Before every checkins/h2>
4 <li> All changes comply no stray changes
5
6 2Before every cu> run the following checklist prior to <u>e
7 4. The checkin will not cause a uninten"Autosync" is enabled &ra
A www/contribute.wiki
+53
--- a/www/contribute.wiki
+++ b/www/contribute.wiki
@@ -0,0 +1,53 @@
1
+<title>ContrUTo Fossil</title>
2
+
3
+Fossil users Fossiled enhancements back to the
4
+project. This note outlines some of the procedures for making
5
+useful contributions.
6
+
7
+<h2>1.0 Contributor Agreemenle>
8
+
9
+Fossil userstributing To Fossil</title>
10
+
11
+Fossil users are encouraged to contributed enhancements back to the
12
+project. This note outlines some of the procedures for making
13
+useful contributions.
14
+
15
+<h2>1.0 Contributor Agreement</h2>
16
+
17
+In order to accept non-trivial contributions, we <u>must</u> have a
18
+[./copyright-release.pdf | Contributor Agreement (PDF) larger companies
19
+and other ms for Fossil users. Many
20
+lawyer-rich organizations require this as a precondition to using
21
+Fossil.
22
+
23
+If you do not wis h to submit a Contributor Agreement, we would still
24
+welcome your suggestions and example code, but we will - we will be forced to re-impleen which
25
+might take longer.
26
+
27
+<h2>2.0 Submitting atches</h2>
28
+
29
+Suggested changes or bug fixes can be submitted by creating a patch
30
+against <tt current source t. Email patches to
31
+<a hrf="mailto:[email protected]">[email protected]</a>. Be sure to
32
+describe in detai l what the patch does and which version of Fossil
33
+it is written against.
34
+
35
+A<title>Contributing To ing To Fossil</t.
36
+However, without a contributpatch will thout a contributpatch will be
37
+used for reference only -be
38
+used for reference only: it will not be applied to the code. This
39
+mapatch.
40
+
41
+Your patches or changes<title>Ct a Contributor Agreement, we would still
42
+welcome your suggestions and example code, Ore will be forced to re-implement your changes from scratch, which
43
+might take longer.
44
+
45
+We've made exceptions for "trivial" changes in the past, but the
46
+definition of that term is up to the project leader.
47
+
48
+<h2>2.0 Submitting Patches</h2>
49
+
50
+Suggested changes or bug fixes can be submitted by creating a patch
51
+against <tt current source the
52
+[http:/Buildil-archive.com/[email protected]/ | mailing list].
53
+A<title>Contributing To ing To Fossil<
--- a/www/contribute.wiki
+++ b/www/contribute.wiki
@@ -0,0 +1,53 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
--- a/www/contribute.wiki
+++ b/www/contribute.wiki
@@ -0,0 +1,53 @@
1 <title>ContrUTo Fossil</title>
2
3 Fossil users Fossiled enhancements back to the
4 project. This note outlines some of the procedures for making
5 useful contributions.
6
7 <h2>1.0 Contributor Agreemenle>
8
9 Fossil userstributing To Fossil</title>
10
11 Fossil users are encouraged to contributed enhancements back to the
12 project. This note outlines some of the procedures for making
13 useful contributions.
14
15 <h2>1.0 Contributor Agreement</h2>
16
17 In order to accept non-trivial contributions, we <u>must</u> have a
18 [./copyright-release.pdf | Contributor Agreement (PDF) larger companies
19 and other ms for Fossil users. Many
20 lawyer-rich organizations require this as a precondition to using
21 Fossil.
22
23 If you do not wis h to submit a Contributor Agreement, we would still
24 welcome your suggestions and example code, but we will - we will be forced to re-impleen which
25 might take longer.
26
27 <h2>2.0 Submitting atches</h2>
28
29 Suggested changes or bug fixes can be submitted by creating a patch
30 against <tt current source t. Email patches to
31 <a hrf="mailto:[email protected]">[email protected]</a>. Be sure to
32 describe in detai l what the patch does and which version of Fossil
33 it is written against.
34
35 A<title>Contributing To ing To Fossil</t.
36 However, without a contributpatch will thout a contributpatch will be
37 used for reference only -be
38 used for reference only: it will not be applied to the code. This
39 mapatch.
40
41 Your patches or changes<title>Ct a Contributor Agreement, we would still
42 welcome your suggestions and example code, Ore will be forced to re-implement your changes from scratch, which
43 might take longer.
44
45 We've made exceptions for "trivial" changes in the past, but the
46 definition of that term is up to the project leader.
47
48 <h2>2.0 Submitting Patches</h2>
49
50 Suggested changes or bug fixes can be submitted by creating a patch
51 against <tt current source the
52 [http:/Buildil-archive.com/[email protected]/ | mailing list].
53 A<title>Contributing To ing To Fossil<
M www/index.wiki
+2
--- www/index.wiki
+++ www/index.wiki
@@ -140,10 +140,12 @@
140140
 * [./inout.wiki | Import and export] from and to Git.
141141
 * [./fossil-v-git.wiki | Fossil versus Git].
142142
143143
 <h3>Links For Fossil Developer:</h3>
144144
145
+ * [./contribute.wiki | Contributing] code or documentation to the
146
+ Fossil project.
145147
 * [./theory1.wiki | Thoughts On The Design Of Fossil].
146148
 * [./pop.wiki | Principles Of Operation]
147149
 * [./tech_overview.wiki | A Technical Overview Of Fossil].
148150
 * The [./fileformat.wiki | file format] used by every content
149151
 file stored in the repository.
150152
--- www/index.wiki
+++ www/index.wiki
@@ -140,10 +140,12 @@
140 * [./inout.wiki | Import and export] from and to Git.
141 * [./fossil-v-git.wiki | Fossil versus Git].
142
143 <h3>Links For Fossil Developer:</h3>
144
 
 
145 * [./theory1.wiki | Thoughts On The Design Of Fossil].
146 * [./pop.wiki | Principles Of Operation]
147 * [./tech_overview.wiki | A Technical Overview Of Fossil].
148 * The [./fileformat.wiki | file format] used by every content
149 file stored in the repository.
150
--- www/index.wiki
+++ www/index.wiki
@@ -140,10 +140,12 @@
140 * [./inout.wiki | Import and export] from and to Git.
141 * [./fossil-v-git.wiki | Fossil versus Git].
142
143 <h3>Links For Fossil Developer:</h3>
144
145 * [./contribute.wiki | Contributing] code or documentation to the
146 Fossil project.
147 * [./theory1.wiki | Thoughts On The Design Of Fossil].
148 * [./pop.wiki | Principles Of Operation]
149 * [./tech_overview.wiki | A Technical Overview Of Fossil].
150 * The [./fileformat.wiki | file format] used by every content
151 file stored in the repository.
152
M www/mkindex.tcl
+4
--- www/mkindex.tcl
+++ www/mkindex.tcl
@@ -9,11 +9,13 @@
99
 set doclist {
1010
 bugtheory.wiki {Bug Tracking In Fossil}
1111
 branching.wiki {Branching, Forking, Merging, and Tagging}
1212
 build.wiki {Building and Installing Fossil}
1313
 checkin_names.wiki {Checkin And Version Names}
14
+ copyright-release.html {Contributor License Agreement}
1415
 concepts.wiki {Fossil Core Concepts}
16
+ contribute.wiki {Contributing Code or Documentation To The Fossil Project}
1517
 custom_ticket.wiki {Customizing The Ticket System}
1618
 delta_encoder_algorithm.wiki {Fossil Delta Encoding Algorithm}
1719
 delta_format.wiki {Fossil Delta Format}
1820
 embeddeddoc.wiki {Embedded Project Documentation}
1921
 event.wiki {Events}
@@ -27,15 +29,17 @@
2729
 pop.wiki {Principles Of Operations}
2830
 qandc.wiki {Questions And Criticisms}
2931
 quickstart.wiki {Fossil Quick Start Guide}
3032
 quotes.wiki
3133
 {Quotes: What People Are Saying About Fossil, Git, and DVCSes in General}
34
+ ../test/release-checklist.wiki {Pre-Release Testing Checklist}
3235
 selfcheck.wiki {Fossil Repository Integrity Self Checks}
3336
 selfhost.wiki {Fossil Self Hosting Repositories}
3437
 server.wiki {How To Configure A Fossil Server}
3538
 shunning.wiki {Shunning: Deleting Content From Fossil}
3639
 stats.wiki {Performance Statistics}
40
+ style.wiki {Source Code Style Guidelines}
3741
 sync.wiki {The Fossil Sync Protocol}
3842
 tech_overview.wiki {A Technical Overview Of The Design And Implementation
3943
 Of Fossil}
4044
 tech_overview.wiki {SQLite Databases Used By Fossil}
4145
 theory1.wiki {Thoughts On The Design Of The Fossil DVCS}
4246
--- www/mkindex.tcl
+++ www/mkindex.tcl
@@ -9,11 +9,13 @@
9 set doclist {
10 bugtheory.wiki {Bug Tracking In Fossil}
11 branching.wiki {Branching, Forking, Merging, and Tagging}
12 build.wiki {Building and Installing Fossil}
13 checkin_names.wiki {Checkin And Version Names}
 
14 concepts.wiki {Fossil Core Concepts}
 
15 custom_ticket.wiki {Customizing The Ticket System}
16 delta_encoder_algorithm.wiki {Fossil Delta Encoding Algorithm}
17 delta_format.wiki {Fossil Delta Format}
18 embeddeddoc.wiki {Embedded Project Documentation}
19 event.wiki {Events}
@@ -27,15 +29,17 @@
27 pop.wiki {Principles Of Operations}
28 qandc.wiki {Questions And Criticisms}
29 quickstart.wiki {Fossil Quick Start Guide}
30 quotes.wiki
31 {Quotes: What People Are Saying About Fossil, Git, and DVCSes in General}
 
32 selfcheck.wiki {Fossil Repository Integrity Self Checks}
33 selfhost.wiki {Fossil Self Hosting Repositories}
34 server.wiki {How To Configure A Fossil Server}
35 shunning.wiki {Shunning: Deleting Content From Fossil}
36 stats.wiki {Performance Statistics}
 
37 sync.wiki {The Fossil Sync Protocol}
38 tech_overview.wiki {A Technical Overview Of The Design And Implementation
39 Of Fossil}
40 tech_overview.wiki {SQLite Databases Used By Fossil}
41 theory1.wiki {Thoughts On The Design Of The Fossil DVCS}
42
--- www/mkindex.tcl
+++ www/mkindex.tcl
@@ -9,11 +9,13 @@
9 set doclist {
10 bugtheory.wiki {Bug Tracking In Fossil}
11 branching.wiki {Branching, Forking, Merging, and Tagging}
12 build.wiki {Building and Installing Fossil}
13 checkin_names.wiki {Checkin And Version Names}
14 copyright-release.html {Contributor License Agreement}
15 concepts.wiki {Fossil Core Concepts}
16 contribute.wiki {Contributing Code or Documentation To The Fossil Project}
17 custom_ticket.wiki {Customizing The Ticket System}
18 delta_encoder_algorithm.wiki {Fossil Delta Encoding Algorithm}
19 delta_format.wiki {Fossil Delta Format}
20 embeddeddoc.wiki {Embedded Project Documentation}
21 event.wiki {Events}
@@ -27,15 +29,17 @@
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 selfcheck.wiki {Fossil Repository Integrity Self Checks}
36 selfhost.wiki {Fossil Self Hosting Repositories}
37 server.wiki {How To Configure A Fossil Server}
38 shunning.wiki {Shunning: Deleting Content From Fossil}
39 stats.wiki {Performance Statistics}
40 style.wiki {Source Code Style Guidelines}
41 sync.wiki {The Fossil Sync Protocol}
42 tech_overview.wiki {A Technical Overview Of The Design And Implementation
43 Of Fossil}
44 tech_overview.wiki {SQLite Databases Used By Fossil}
45 theory1.wiki {Thoughts On The Design Of The Fossil DVCS}
46
M www/permutedindex.wiki
+15
--- www/permutedindex.wiki
+++ www/permutedindex.wiki
@@ -2,22 +2,28 @@
22
 <nowiki>
33
 <ul>
44
 <li><a href="event.wiki">Events</a></li>
55
 <li><a href="tech_overview.wiki">A Technical Overview Of The Design And Implementation
66
 Of Fossil</a></li>
7
+<li><a href="copyright-release.html">Agreement &#151; Contributor License</a></li>
78
 <li><a href="delta_encoder_algorithm.wiki">Algorithm &#151; Fossil Delta Encoding</a></li>
89
 <li><a href="faq.wiki">Asked Questions &#151; Frequently</a></li>
910
 <li><a href="password.wiki">Authentication &#151; Password Management And</a></li>
1011
 <li><a href="branching.wiki">Branching, Forking, Merging, and Tagging</a></li>
1112
 <li><a href="bugtheory.wiki">Bug Tracking In Fossil</a></li>
1213
 <li><a href="makefile.wiki">Build Process &#151; The Fossil</a></li>
1314
 <li><a href="build.wiki">Building and Installing Fossil</a></li>
1415
 <li><a href="checkin_names.wiki">Checkin And Version Names</a></li>
16
+<li><a href="../test/release-checklist.wiki">Checklist &#151; Pre-Release Testing</a></li>
1517
 <li><a href="selfcheck.wiki">Checks &#151; Fossil Repository Integrity Self</a></li>
18
+<li><a href="contribute.wiki">Code or Documentation To The Fossil Project &#151; Contributing</a></li>
19
+<li><a href="style.wiki">Code Style Guidelines &#151; Source</a></li>
1620
 <li><a href="concepts.wiki">Concepts &#151; Fossil Core</a></li>
1721
 <li><a href="server.wiki">Configure A Fossil Server &#151; How To</a></li>
1822
 <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>
1925
 <li><a href="concepts.wiki">Core Concepts &#151; Fossil</a></li>
2026
 <li><a href="qandc.wiki">Criticisms &#151; Questions And</a></li>
2127
 <li><a href="custom_ticket.wiki">Customizing The Ticket System</a></li>
2228
 <li><a href="tech_overview.wiki">Databases Used By Fossil &#151; SQLite</a></li>
2329
 <li><a href="shunning.wiki">Deleting Content From Fossil &#151; Shunning:</a></li>
@@ -24,10 +30,11 @@
2430
 <li><a href="delta_encoder_algorithm.wiki">Delta Encoding Algorithm &#151; Fossil</a></li>
2531
 <li><a href="delta_format.wiki">Delta Format &#151; Fossil</a></li>
2632
 <li><a href="tech_overview.wiki">Design And Implementation Of Fossil &#151; A Technical Overview Of The</a></li>
2733
 <li><a href="theory1.wiki">Design Of The Fossil DVCS &#151; Thoughts On The</a></li>
2834
 <li><a href="embeddeddoc.wiki">Documentation &#151; Embedded Project</a></li>
35
+<li><a href="contribute.wiki">Documentation To The Fossil Project &#151; Contributing Code or</a></li>
2936
 <li><a href="theory1.wiki">DVCS &#151; Thoughts On The Design Of The Fossil</a></li>
3037
 <li><a href="quotes.wiki">DVCSes in General &#151; Quotes: What People Are Saying About Fossil, Git, and</a></li>
3138
 <li><a href="embeddeddoc.wiki">Embedded Project Documentation</a></li>
3239
 <li><a href="delta_encoder_algorithm.wiki">Encoding Algorithm &#151; Fossil Delta</a></li>
3340
 <li><a href="inout.wiki">Export To And From Git &#151; Import And</a></li>
@@ -50,29 +57,34 @@
5057
 <li><a href="quotes.wiki">General &#151; Quotes: What People Are Saying About Fossil, Git, and DVCSes in</a></li>
5158
 <li><a href="fossil-v-git.wiki">Git &#151; Fossil Versus</a></li>
5259
 <li><a href="inout.wiki">Git &#151; Import And Export To And From</a></li>
5360
 <li><a href="quotes.wiki">Git, and DVCSes in General &#151; Quotes: What People Are Saying About Fossil,</a></li>
5461
 <li><a href="quickstart.wiki">Guide &#151; Fossil Quick Start</a></li>
62
+<li><a href="style.wiki">Guidelines &#151; Source Code Style</a></li>
5563
 <li><a href="index.wiki">Home Page</a></li>
5664
 <li><a href="selfhost.wiki">Hosting Repositories &#151; Fossil Self</a></li>
5765
 <li><a href="server.wiki">How To Configure A Fossil Server</a></li>
5866
 <li><a href="tech_overview.wiki">Implementation Of Fossil &#151; A Technical Overview Of The Design And</a></li>
5967
 <li><a href="inout.wiki">Import And Export To And From Git</a></li>
6068
 <li><a href="build.wiki">Installing Fossil &#151; Building and</a></li>
6169
 <li><a href="selfcheck.wiki">Integrity Self Checks &#151; Fossil Repository</a></li>
6270
 <li><a href="webui.wiki">Interface &#151; The Fossil Web</a></li>
71
+<li><a href="copyright-release.html">License Agreement &#151; Contributor</a></li>
6372
 <li><a href="password.wiki">Management And Authentication &#151; Password</a></li>
6473
 <li><a href="branching.wiki">Merging, and Tagging &#151; Branching, Forking,</a></li>
6574
 <li><a href="checkin_names.wiki">Names &#151; Checkin And Version</a></li>
6675
 <li><a href="pop.wiki">Operations &#151; Principles Of</a></li>
76
+<li><a href="contribute.wiki">or Documentation To The Fossil Project &#151; Contributing Code</a></li>
6777
 <li><a href="tech_overview.wiki">Overview Of The Design And Implementation Of Fossil &#151; A Technical</a></li>
6878
 <li><a href="index.wiki">Page &#151; Home</a></li>
6979
 <li><a href="password.wiki">Password Management And Authentication</a></li>
7080
 <li><a href="quotes.wiki">People Are Saying About Fossil, Git, and DVCSes in General &#151; Quotes: What</a></li>
7181
 <li><a href="stats.wiki">Performance Statistics</a></li>
82
+<li><a href="../test/release-checklist.wiki">Pre-Release Testing Checklist</a></li>
7283
 <li><a href="pop.wiki">Principles Of Operations</a></li>
7384
 <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>
7486
 <li><a href="embeddeddoc.wiki">Project Documentation &#151; Embedded</a></li>
7587
 <li><a href="sync.wiki">Protocol &#151; The Fossil Sync</a></li>
7688
 <li><a href="faq.wiki">Questions &#151; Frequently Asked</a></li>
7789
 <li><a href="qandc.wiki">Questions And Criticisms</a></li>
7890
 <li><a href="quickstart.wiki">Quick Start Guide &#151; Fossil</a></li>
@@ -82,17 +94,20 @@
8294
 <li><a href="quotes.wiki">Saying About Fossil, Git, and DVCSes in General &#151; Quotes: What People Are</a></li>
8395
 <li><a href="selfcheck.wiki">Self Checks &#151; Fossil Repository Integrity</a></li>
8496
 <li><a href="selfhost.wiki">Self Hosting Repositories &#151; Fossil</a></li>
8597
 <li><a href="server.wiki">Server &#151; How To Configure A Fossil</a></li>
8698
 <li><a href="shunning.wiki">Shunning: Deleting Content From Fossil</a></li>
99
+<li><a href="style.wiki">Source Code Style Guidelines</a></li>
87100
 <li><a href="tech_overview.wiki">SQLite Databases Used By Fossil</a></li>
88101
 <li><a href="quickstart.wiki">Start Guide &#151; Fossil Quick</a></li>
89102
 <li><a href="stats.wiki">Statistics &#151; Performance</a></li>
103
+<li><a href="style.wiki">Style Guidelines &#151; Source Code</a></li>
90104
 <li><a href="sync.wiki">Sync Protocol &#151; The Fossil</a></li>
91105
 <li><a href="custom_ticket.wiki">System &#151; Customizing The Ticket</a></li>
92106
 <li><a href="branching.wiki">Tagging &#151; Branching, Forking, Merging, and</a></li>
93107
 <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>
94109
 <li><a href="makefile.wiki">The Fossil Build Process</a></li>
95110
 <li><a href="sync.wiki">The Fossil Sync Protocol</a></li>
96111
 <li><a href="webui.wiki">The Fossil Web Interface</a></li>
97112
 <li><a href="theory1.wiki">Thoughts On The Design Of The Fossil DVCS</a></li>
98113
 <li><a href="custom_ticket.wiki">Ticket System &#151; Customizing The</a></li>
99114
100115
ADDED www/style.wiki
--- www/permutedindex.wiki
+++ www/permutedindex.wiki
@@ -2,22 +2,28 @@
2 <nowiki>
3 <ul>
4 <li><a href="event.wiki">Events</a></li>
5 <li><a href="tech_overview.wiki">A Technical Overview Of The Design And Implementation
6 Of Fossil</a></li>
 
7 <li><a href="delta_encoder_algorithm.wiki">Algorithm &#151; Fossil Delta Encoding</a></li>
8 <li><a href="faq.wiki">Asked Questions &#151; Frequently</a></li>
9 <li><a href="password.wiki">Authentication &#151; Password Management And</a></li>
10 <li><a href="branching.wiki">Branching, Forking, Merging, and Tagging</a></li>
11 <li><a href="bugtheory.wiki">Bug Tracking In Fossil</a></li>
12 <li><a href="makefile.wiki">Build Process &#151; The Fossil</a></li>
13 <li><a href="build.wiki">Building and Installing Fossil</a></li>
14 <li><a href="checkin_names.wiki">Checkin And Version Names</a></li>
 
15 <li><a href="selfcheck.wiki">Checks &#151; Fossil Repository Integrity Self</a></li>
 
 
16 <li><a href="concepts.wiki">Concepts &#151; Fossil Core</a></li>
17 <li><a href="server.wiki">Configure A Fossil Server &#151; How To</a></li>
18 <li><a href="shunning.wiki">Content From Fossil &#151; Shunning: Deleting</a></li>
 
 
19 <li><a href="concepts.wiki">Core Concepts &#151; Fossil</a></li>
20 <li><a href="qandc.wiki">Criticisms &#151; Questions And</a></li>
21 <li><a href="custom_ticket.wiki">Customizing The Ticket System</a></li>
22 <li><a href="tech_overview.wiki">Databases Used By Fossil &#151; SQLite</a></li>
23 <li><a href="shunning.wiki">Deleting Content From Fossil &#151; Shunning:</a></li>
@@ -24,10 +30,11 @@
24 <li><a href="delta_encoder_algorithm.wiki">Delta Encoding Algorithm &#151; Fossil</a></li>
25 <li><a href="delta_format.wiki">Delta Format &#151; Fossil</a></li>
26 <li><a href="tech_overview.wiki">Design And Implementation Of Fossil &#151; A Technical Overview Of The</a></li>
27 <li><a href="theory1.wiki">Design Of The Fossil DVCS &#151; Thoughts On The</a></li>
28 <li><a href="embeddeddoc.wiki">Documentation &#151; Embedded Project</a></li>
 
29 <li><a href="theory1.wiki">DVCS &#151; Thoughts On The Design Of The Fossil</a></li>
30 <li><a href="quotes.wiki">DVCSes in General &#151; Quotes: What People Are Saying About Fossil, Git, and</a></li>
31 <li><a href="embeddeddoc.wiki">Embedded Project Documentation</a></li>
32 <li><a href="delta_encoder_algorithm.wiki">Encoding Algorithm &#151; Fossil Delta</a></li>
33 <li><a href="inout.wiki">Export To And From Git &#151; Import And</a></li>
@@ -50,29 +57,34 @@
50 <li><a href="quotes.wiki">General &#151; Quotes: What People Are Saying About Fossil, Git, and DVCSes in</a></li>
51 <li><a href="fossil-v-git.wiki">Git &#151; Fossil Versus</a></li>
52 <li><a href="inout.wiki">Git &#151; Import And Export To And From</a></li>
53 <li><a href="quotes.wiki">Git, and DVCSes in General &#151; Quotes: What People Are Saying About Fossil,</a></li>
54 <li><a href="quickstart.wiki">Guide &#151; Fossil Quick Start</a></li>
 
55 <li><a href="index.wiki">Home Page</a></li>
56 <li><a href="selfhost.wiki">Hosting Repositories &#151; Fossil Self</a></li>
57 <li><a href="server.wiki">How To Configure A Fossil Server</a></li>
58 <li><a href="tech_overview.wiki">Implementation Of Fossil &#151; A Technical Overview Of The Design And</a></li>
59 <li><a href="inout.wiki">Import And Export To And From Git</a></li>
60 <li><a href="build.wiki">Installing Fossil &#151; Building and</a></li>
61 <li><a href="selfcheck.wiki">Integrity Self Checks &#151; Fossil Repository</a></li>
62 <li><a href="webui.wiki">Interface &#151; The Fossil Web</a></li>
 
63 <li><a href="password.wiki">Management And Authentication &#151; Password</a></li>
64 <li><a href="branching.wiki">Merging, and Tagging &#151; Branching, Forking,</a></li>
65 <li><a href="checkin_names.wiki">Names &#151; Checkin And Version</a></li>
66 <li><a href="pop.wiki">Operations &#151; Principles Of</a></li>
 
67 <li><a href="tech_overview.wiki">Overview Of The Design And Implementation Of Fossil &#151; A Technical</a></li>
68 <li><a href="index.wiki">Page &#151; Home</a></li>
69 <li><a href="password.wiki">Password Management And Authentication</a></li>
70 <li><a href="quotes.wiki">People Are Saying About Fossil, Git, and DVCSes in General &#151; Quotes: What</a></li>
71 <li><a href="stats.wiki">Performance Statistics</a></li>
 
72 <li><a href="pop.wiki">Principles Of Operations</a></li>
73 <li><a href="makefile.wiki">Process &#151; The Fossil Build</a></li>
 
74 <li><a href="embeddeddoc.wiki">Project Documentation &#151; Embedded</a></li>
75 <li><a href="sync.wiki">Protocol &#151; The Fossil Sync</a></li>
76 <li><a href="faq.wiki">Questions &#151; Frequently Asked</a></li>
77 <li><a href="qandc.wiki">Questions And Criticisms</a></li>
78 <li><a href="quickstart.wiki">Quick Start Guide &#151; Fossil</a></li>
@@ -82,17 +94,20 @@
82 <li><a href="quotes.wiki">Saying About Fossil, Git, and DVCSes in General &#151; Quotes: What People Are</a></li>
83 <li><a href="selfcheck.wiki">Self Checks &#151; Fossil Repository Integrity</a></li>
84 <li><a href="selfhost.wiki">Self Hosting Repositories &#151; Fossil</a></li>
85 <li><a href="server.wiki">Server &#151; How To Configure A Fossil</a></li>
86 <li><a href="shunning.wiki">Shunning: Deleting Content From Fossil</a></li>
 
87 <li><a href="tech_overview.wiki">SQLite Databases Used By Fossil</a></li>
88 <li><a href="quickstart.wiki">Start Guide &#151; Fossil Quick</a></li>
89 <li><a href="stats.wiki">Statistics &#151; Performance</a></li>
 
90 <li><a href="sync.wiki">Sync Protocol &#151; The Fossil</a></li>
91 <li><a href="custom_ticket.wiki">System &#151; Customizing The Ticket</a></li>
92 <li><a href="branching.wiki">Tagging &#151; Branching, Forking, Merging, and</a></li>
93 <li><a href="tech_overview.wiki">Technical Overview Of The Design And Implementation Of Fossil &#151; A</a></li>
 
94 <li><a href="makefile.wiki">The Fossil Build Process</a></li>
95 <li><a href="sync.wiki">The Fossil Sync Protocol</a></li>
96 <li><a href="webui.wiki">The Fossil Web Interface</a></li>
97 <li><a href="theory1.wiki">Thoughts On The Design Of The Fossil DVCS</a></li>
98 <li><a href="custom_ticket.wiki">Ticket System &#151; Customizing The</a></li>
99
100 DDED www/style.wiki
--- www/permutedindex.wiki
+++ www/permutedindex.wiki
@@ -2,22 +2,28 @@
2 <nowiki>
3 <ul>
4 <li><a href="event.wiki">Events</a></li>
5 <li><a href="tech_overview.wiki">A Technical Overview Of The Design And Implementation
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>
16 <li><a href="../test/release-checklist.wiki">Checklist &#151; Pre-Release Testing</a></li>
17 <li><a href="selfcheck.wiki">Checks &#151; Fossil Repository Integrity Self</a></li>
18 <li><a href="contribute.wiki">Code or Documentation To The Fossil Project &#151; Contributing</a></li>
19 <li><a href="style.wiki">Code Style Guidelines &#151; Source</a></li>
20 <li><a href="concepts.wiki">Concepts &#151; Fossil Core</a></li>
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>
@@ -24,10 +30,11 @@
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>
35 <li><a href="contribute.wiki">Documentation To The Fossil Project &#151; Contributing Code or</a></li>
36 <li><a href="theory1.wiki">DVCS &#151; Thoughts On The Design Of The Fossil</a></li>
37 <li><a href="quotes.wiki">DVCSes in General &#151; Quotes: What People Are Saying About Fossil, Git, and</a></li>
38 <li><a href="embeddeddoc.wiki">Embedded Project Documentation</a></li>
39 <li><a href="delta_encoder_algorithm.wiki">Encoding Algorithm &#151; Fossil Delta</a></li>
40 <li><a href="inout.wiki">Export To And From Git &#151; Import And</a></li>
@@ -50,29 +57,34 @@
57 <li><a href="quotes.wiki">General &#151; Quotes: What People Are Saying About Fossil, Git, and DVCSes in</a></li>
58 <li><a href="fossil-v-git.wiki">Git &#151; Fossil Versus</a></li>
59 <li><a href="inout.wiki">Git &#151; Import And Export To And From</a></li>
60 <li><a href="quotes.wiki">Git, and DVCSes in General &#151; Quotes: What People Are Saying About Fossil,</a></li>
61 <li><a href="quickstart.wiki">Guide &#151; Fossil Quick Start</a></li>
62 <li><a href="style.wiki">Guidelines &#151; Source Code Style</a></li>
63 <li><a href="index.wiki">Home Page</a></li>
64 <li><a href="selfhost.wiki">Hosting Repositories &#151; Fossil Self</a></li>
65 <li><a href="server.wiki">How To Configure A Fossil Server</a></li>
66 <li><a href="tech_overview.wiki">Implementation Of Fossil &#151; A Technical Overview Of The Design And</a></li>
67 <li><a href="inout.wiki">Import And Export To And From Git</a></li>
68 <li><a href="build.wiki">Installing Fossil &#151; Building and</a></li>
69 <li><a href="selfcheck.wiki">Integrity Self Checks &#151; Fossil Repository</a></li>
70 <li><a href="webui.wiki">Interface &#151; The Fossil Web</a></li>
71 <li><a href="copyright-release.html">License Agreement &#151; Contributor</a></li>
72 <li><a href="password.wiki">Management And Authentication &#151; Password</a></li>
73 <li><a href="branching.wiki">Merging, and Tagging &#151; Branching, Forking,</a></li>
74 <li><a href="checkin_names.wiki">Names &#151; Checkin And Version</a></li>
75 <li><a href="pop.wiki">Operations &#151; Principles Of</a></li>
76 <li><a href="contribute.wiki">or Documentation To The Fossil Project &#151; Contributing Code</a></li>
77 <li><a href="tech_overview.wiki">Overview Of The Design And Implementation Of Fossil &#151; A Technical</a></li>
78 <li><a href="index.wiki">Page &#151; Home</a></li>
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>
89 <li><a href="qandc.wiki">Questions And Criticisms</a></li>
90 <li><a href="quickstart.wiki">Quick Start Guide &#151; Fossil</a></li>
@@ -82,17 +94,20 @@
94 <li><a href="quotes.wiki">Saying About Fossil, Git, and DVCSes in General &#151; Quotes: What People Are</a></li>
95 <li><a href="selfcheck.wiki">Self Checks &#151; Fossil Repository Integrity</a></li>
96 <li><a href="selfhost.wiki">Self Hosting Repositories &#151; Fossil</a></li>
97 <li><a href="server.wiki">Server &#151; How To Configure A Fossil</a></li>
98 <li><a href="shunning.wiki">Shunning: Deleting Content From Fossil</a></li>
99 <li><a href="style.wiki">Source Code Style Guidelines</a></li>
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 <li><a href="sync.wiki">The Fossil Sync Protocol</a></li>
111 <li><a href="webui.wiki">The Fossil Web Interface</a></li>
112 <li><a href="theory1.wiki">Thoughts On The Design Of The Fossil DVCS</a></li>
113 <li><a href="custom_ticket.wiki">Ticket System &#151; Customizing The</a></li>
114
115 DDED www/style.wiki
A www/style.wiki
+56
--- a/www/style.wiki
+++ b/www/style.wiki
@@ -0,0 +1,56 @@
1
+<title>Coding Style</title>
2
+
3
+Fossiingl source code should follow the style guideline:s below.
4
+
5
+<b>General points</b>:
6
+
7
+ 10. No line of code exceeds 80 characters in length. (Occasional
8
+ exceptions are made for11. There are no tab characters.
9
+
10
+ 12. no tab characters.
11
+
12
+ <li> Line terminators are \n only. Do not use 13.\n line terminator.
13
+
14
+ <li> 14.Remember: No tabs.
15
+
16
+ <li> Comments contain no spelling or grammatical errors. (Abbreviations
17
+ and sentence fragments are acceptable when trying to fit a comment
18
+ on a single line as long as15. The tone of comments is professional and courteous. Comments
19
+ contain no profanity, 16.<titleeaded. Do not use threads.
20
+ (One exception to this is the HTTP server implementation for Windows,
21
+ which we do not know how to implement without the use of threads.)
22
+
23
+</ol>
24
+
25
+<b>2. C preprocessor macros</b>:
26
+
27
+<ol>
28
+
29
+ <li value=20> e purpose of every preprocessor macros is clearwy explained in a
30
+ comment associated with its definition.
31
+
32
+ <li> Every preprocessor macro is used at least once.
33
+
34
+ <li> The names of preprocessor macros clearly reflect their use.
35
+
36
+ <li> Assumptions about the relative values of related macros are
37
+ verified by asserts. Example: <tt>assert(READ_LOCK+1==WRITE_LOCK);</tt>
38
+
39
+</ol>
40
+
41
+
42
+<b>3. Function header comments</b>:
43
+
44
+<ol>
45
+ <li value=30> Every function has a header comment describing the purpose and use
46
+
47
+ Three well-defi into strings, which may exceed the 509 character limit defined by ANSI.
48
+ (example: bld/page_index.h)
49
+
50
+ <li> -Wno-long-long: Fossil uses the 'long long' integer type, which is not strictly ANSI C-89 (defined in C99).
51
+ The use of 'long long'resolves many problems with 64-bit arithmetics, especially on 32-bit machines.
52
+ (http_ssl.c, sha3.c, shell.c, util.c)
53
+
54
+ <li> alloca(): By default, sqlite3.c was compiled with the -DSQLITE_USE_ALLOCA flag to use the alloca() function.
55
+ This is no longer the case as of 20220119. alloca() is not considered ANSI C, and normally not
56
+ recommended due to portability issues,
--- a/www/style.wiki
+++ b/www/style.wiki
@@ -0,0 +1,56 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
--- a/www/style.wiki
+++ b/www/style.wiki
@@ -0,0 +1,56 @@
1 <title>Coding Style</title>
2
3 Fossiingl source code should follow the style guideline:s below.
4
5 <b>General points</b>:
6
7 10. No line of code exceeds 80 characters in length. (Occasional
8 exceptions are made for11. There are no tab characters.
9
10 12. no tab characters.
11
12 <li> Line terminators are \n only. Do not use 13.\n line terminator.
13
14 <li> 14.Remember: No tabs.
15
16 <li> Comments contain no spelling or grammatical errors. (Abbreviations
17 and sentence fragments are acceptable when trying to fit a comment
18 on a single line as long as15. The tone of comments is professional and courteous. Comments
19 contain no profanity, 16.<titleeaded. Do not use threads.
20 (One exception to this is the HTTP server implementation for Windows,
21 which we do not know how to implement without the use of threads.)
22
23 </ol>
24
25 <b>2. C preprocessor macros</b>:
26
27 <ol>
28
29 <li value=20> e purpose of every preprocessor macros is clearwy explained in a
30 comment associated with its definition.
31
32 <li> Every preprocessor macro is used at least once.
33
34 <li> The names of preprocessor macros clearly reflect their use.
35
36 <li> Assumptions about the relative values of related macros are
37 verified by asserts. Example: <tt>assert(READ_LOCK+1==WRITE_LOCK);</tt>
38
39 </ol>
40
41
42 <b>3. Function header comments</b>:
43
44 <ol>
45 <li value=30> Every function has a header comment describing the purpose and use
46
47 Three well-defi into strings, which may exceed the 509 character limit defined by ANSI.
48 (example: bld/page_index.h)
49
50 <li> -Wno-long-long: Fossil uses the 'long long' integer type, which is not strictly ANSI C-89 (defined in C99).
51 The use of 'long long'resolves many problems with 64-bit arithmetics, especially on 32-bit machines.
52 (http_ssl.c, sha3.c, shell.c, util.c)
53
54 <li> alloca(): By default, sqlite3.c was compiled with the -DSQLITE_USE_ALLOCA flag to use the alloca() function.
55 This is no longer the case as of 20220119. alloca() is not considered ANSI C, and normally not
56 recommended due to portability issues,

Keyboard Shortcuts

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