Fossil SCM

Add some documentation to help programmers get started hacking the Fossil sources.

drh 2013-07-20 03:18 trunk

Commit 018a9830469a36b2a9da9a1ad383ceecb44e5229

Parent e94bef2dec75ae7…

6 files changed +1 +1 +7 +2 +4 +6

+ www/adding_code.wiki ~ www/contribute.wiki ~ www/makefile.wiki ~ www/mkindex.tcl ~ www/permutedindex.wiki ~ www/tech_overview.wiki

A www/adding_code.wiki

		--- a/www/adding_code.wiki
		+++ b/www/adding_code.wiki
		@@ -0,0 +1 @@
	1	+agt the thehelp

	--- a/www/adding_code.wiki
	+++ b/www/adding_code.wiki
	@@ -0,0 +1 @@

	--- a/www/adding_code.wiki
	+++ b/www/adding_code.wiki
	@@ -0,0 +1 @@
1	agt the thehelp

M www/contribute.wiki

		--- www/contribute.wiki
		+++ www/contribute.wiki
		@@ -78,5 +78,6 @@
78	78	<h2>5.0 See Also</h2>
79	79
80	80	* [./build.wiki \| How To Compile And Install Fossil]
81	81	* [./makefile.wiki \| The Fossil Build Process]
82	82	* [./tech_overview.wiki \| A Technical Overview of Fossil]
	83	+ * [./adding_code.wiki \| Adding Features To Fossil]
83	84

	--- www/contribute.wiki
	+++ www/contribute.wiki
	@@ -78,5 +78,6 @@
78	<h2>5.0 See Also</h2>
79
80	* [./build.wiki \| How To Compile And Install Fossil]
81	* [./makefile.wiki \| The Fossil Build Process]
82	* [./tech_overview.wiki \| A Technical Overview of Fossil]

83

	--- www/contribute.wiki
	+++ www/contribute.wiki
	@@ -78,5 +78,6 @@
78	<h2>5.0 See Also</h2>
79
80	* [./build.wiki \| How To Compile And Install Fossil]
81	* [./makefile.wiki \| The Fossil Build Process]
82	* [./tech_overview.wiki \| A Technical Overview of Fossil]
83	* [./adding_code.wiki \| Adding Features To Fossil]
84

M www/makefile.wiki

		--- www/makefile.wiki
		+++ www/makefile.wiki
		@@ -12,10 +12,11 @@
12	12	So must people do not need to be concerned with the
13	13	build complexities of Fossil. But hard-core developers who desire
14	14	a deep understanding of how Fossil is put together can benefit
15	15	from reviewing this article.
16	16
	17	+<a name="srctour"></a>
17	18	<h1>2.0 Source Code Tour</h1>
18	19
19	20	The source code for Fossil is found in the
20	21	[/dir?ci=trunk&name=src \| src/] subdirectory of the
21	22	source tree. The src/ subdirectory contains all code, including
		@@ -117,10 +118,11 @@
117	118	directories right. The point is that the manifest.uuid, manifest, and
118	119	VERSION files
119	120	in the root of the source tree are the three arguments and
120	121	the generated VERSION.h file appears on standard output.
121	122
	123	+<a name="preprocessing"></a>
122	124	<h1>4.0 Preprocessing</h1>
123	125
124	126	There are three preprocessors for the Fossil sources. The mkindex
125	127	and translate preprocessors can be run in any order. The makeheaders
126	128	preprocessor must be run after translate.
		@@ -236,5 +238,10 @@
236	238	Fossil needs to be linked against [http://www.zlib.net \| zlib]. If
237	239	the HTTPS option is enabled, then it will also need to link against
238	240	the appropriate SSL implementation. And, of course, Fossil needs to
239	241	link against the standard C library. No other libraries or external
240	242	dependences are used.
	243	+
	244	+<h1>7.0 See Also</h1>
	245	+
	246	+ * [./tech_overview.wiki \| A Technical Overview Of Fossil]
	247	+ * [./adding_code.wiki \| How To Add Features To Fossil]
241	248

	--- www/makefile.wiki
	+++ www/makefile.wiki
	@@ -12,10 +12,11 @@
12	So must people do not need to be concerned with the
13	build complexities of Fossil. But hard-core developers who desire
14	a deep understanding of how Fossil is put together can benefit
15	from reviewing this article.
16

17	<h1>2.0 Source Code Tour</h1>
18
19	The source code for Fossil is found in the
20	[/dir?ci=trunk&name=src \| src/] subdirectory of the
21	source tree. The src/ subdirectory contains all code, including
	@@ -117,10 +118,11 @@
117	directories right. The point is that the manifest.uuid, manifest, and
118	VERSION files
119	in the root of the source tree are the three arguments and
120	the generated VERSION.h file appears on standard output.
121

122	<h1>4.0 Preprocessing</h1>
123
124	There are three preprocessors for the Fossil sources. The mkindex
125	and translate preprocessors can be run in any order. The makeheaders
126	preprocessor must be run after translate.
	@@ -236,5 +238,10 @@
236	Fossil needs to be linked against [http://www.zlib.net \| zlib]. If
237	the HTTPS option is enabled, then it will also need to link against
238	the appropriate SSL implementation. And, of course, Fossil needs to
239	link against the standard C library. No other libraries or external
240	dependences are used.





241

	--- www/makefile.wiki
	+++ www/makefile.wiki
	@@ -12,10 +12,11 @@
12	So must people do not need to be concerned with the
13	build complexities of Fossil. But hard-core developers who desire
14	a deep understanding of how Fossil is put together can benefit
15	from reviewing this article.
16
17	<a name="srctour"></a>
18	<h1>2.0 Source Code Tour</h1>
19
20	The source code for Fossil is found in the
21	[/dir?ci=trunk&name=src \| src/] subdirectory of the
22	source tree. The src/ subdirectory contains all code, including
	@@ -117,10 +118,11 @@
118	directories right. The point is that the manifest.uuid, manifest, and
119	VERSION files
120	in the root of the source tree are the three arguments and
121	the generated VERSION.h file appears on standard output.
122
123	<a name="preprocessing"></a>
124	<h1>4.0 Preprocessing</h1>
125
126	There are three preprocessors for the Fossil sources. The mkindex
127	and translate preprocessors can be run in any order. The makeheaders
128	preprocessor must be run after translate.
	@@ -236,5 +238,10 @@
238	Fossil needs to be linked against [http://www.zlib.net \| zlib]. If
239	the HTTPS option is enabled, then it will also need to link against
240	the appropriate SSL implementation. And, of course, Fossil needs to
241	link against the standard C library. No other libraries or external
242	dependences are used.
243
244	<h1>7.0 See Also</h1>
245
246	* [./tech_overview.wiki \| A Technical Overview Of Fossil]
247	* [./adding_code.wiki \| How To Add Features To Fossil]
248

M www/mkindex.tcl

		--- www/mkindex.tcl
		+++ www/mkindex.tcl
		@@ -5,10 +5,12 @@
5	5	#
6	6	# tclsh mkindex.tcl >permutedindex.wiki
7	7	#
8	8
9	9	set doclist {
	10	+ adding_code.wiki {Adding New Features To Fossil}
	11	+ adding_code.wiki {Hacking Fossil}
10	12	antibot.wiki {Defense against Spiders and Bots}
11	13	bugtheory.wiki {Bug Tracking In Fossil}
12	14	branching.wiki {Branching, Forking, Merging, and Tagging}
13	15	build.wiki {Compiling and Installing Fossil}
14	16	checkin_names.wiki {Checkin And Version Names}
15	17

	--- www/mkindex.tcl
	+++ www/mkindex.tcl
	@@ -5,10 +5,12 @@
5	#
6	# tclsh mkindex.tcl >permutedindex.wiki
7	#
8
9	set doclist {


10	antibot.wiki {Defense against Spiders and Bots}
11	bugtheory.wiki {Bug Tracking In Fossil}
12	branching.wiki {Branching, Forking, Merging, and Tagging}
13	build.wiki {Compiling and Installing Fossil}
14	checkin_names.wiki {Checkin And Version Names}
15

	--- www/mkindex.tcl
	+++ www/mkindex.tcl
	@@ -5,10 +5,12 @@
5	#
6	# tclsh mkindex.tcl >permutedindex.wiki
7	#
8
9	set doclist {
10	adding_code.wiki {Adding New Features To Fossil}
11	adding_code.wiki {Hacking Fossil}
12	antibot.wiki {Defense against Spiders and Bots}
13	bugtheory.wiki {Bug Tracking In Fossil}
14	branching.wiki {Branching, Forking, Merging, and Tagging}
15	build.wiki {Compiling and Installing Fossil}
16	checkin_names.wiki {Checkin And Version Names}
17

M www/permutedindex.wiki

		--- www/permutedindex.wiki
		+++ www/permutedindex.wiki
		@@ -13,10 +13,11 @@
13	13	<h2>Permuted Index:</h2>
14	14	<ul>
15	15	<li><a href="fiveminutes.wiki">5 Minutes as a Single User — Update and Running in</a></li>
16	16	<li><a href="fossil-from-msvc.wiki">2010 IDE — Integrating Fossil in the Microsoft Express</a></li>
17	17	<li><a href="tech_overview.wiki">A Technical Overview Of The Design And Implementation Of Fossil</a></li>
	18	+<li><a href="adding_code.wiki">Adding New Features To Fossil</a></li>
18	19	<li><a href="antibot.wiki">against Spiders and Bots — Defense</a></li>
19	20	<li><a href="copyright-release.html">Agreement — Contributor License</a></li>
20	21	<li><a href="delta_encoder_algorithm.wiki">Algorithm — Fossil Delta Encoding</a></li>
21	22	<li><a href="fiveminutes.wiki">as a Single User — Update and Running in 5 Minutes</a></li>
22	23	<li><a href="faq.wiki">Asked Questions — Frequently</a></li>
		@@ -61,10 +62,11 @@
61	62	<li><a href="embeddeddoc.wiki">Embedded Project Documentation</a></li>
62	63	<li><a href="delta_encoder_algorithm.wiki">Encoding Algorithm — Fossil Delta</a></li>
63	64	<li><a href="event.wiki">Events</a></li>
64	65	<li><a href="inout.wiki">Export To And From Git — Import And</a></li>
65	66	<li><a href="fossil-from-msvc.wiki">Express 2010 IDE — Integrating Fossil in the Microsoft</a></li>
	67	+<li><a href="adding_code.wiki">Features To Fossil — Adding New</a></li>
66	68	<li><a href="fileformat.wiki">File Format — Fossil</a></li>
67	69	<li><a href="branching.wiki">Forking, Merging, and Tagging — Branching,</a></li>
68	70	<li><a href="delta_format.wiki">Format — Fossil Delta</a></li>
69	71	<li><a href="fileformat.wiki">Format — Fossil File</a></li>
70	72	<li><a href="changes.wiki">Fossil Changelog</a></li>
		@@ -86,10 +88,11 @@
86	88	<li><a href="fossil-v-git.wiki">Git — Fossil Versus</a></li>
87	89	<li><a href="inout.wiki">Git — Import And Export To And From</a></li>
88	90	<li><a href="quotes.wiki">Git, and DVCSes in General — Quotes: What People Are Saying About Fossil,</a></li>
89	91	<li><a href="quickstart.wiki">Guide — Fossil Quick Start</a></li>
90	92	<li><a href="style.wiki">Guidelines — Source Code Style</a></li>
	93	+<li><a href="adding_code.wiki">Hacking Fossil</a></li>
91	94	<li><a href="hints.wiki">Hints — Fossil Tips And Usage</a></li>
92	95	<li><a href="index.wiki">Home Page</a></li>
93	96	<li><a href="selfhost.wiki">Hosting Repositories — Fossil Self</a></li>
94	97	<li><a href="server.wiki">How To Configure A Fossil Server</a></li>
95	98	<li><a href="newrepo.wiki">How To Create A New Fossil Repository</a></li>
		@@ -104,10 +107,11 @@
104	107	<li><a href="password.wiki">Management And Authentication — Password</a></li>
105	108	<li><a href="branching.wiki">Merging, and Tagging — Branching, Forking,</a></li>
106	109	<li><a href="fossil-from-msvc.wiki">Microsoft Express 2010 IDE — Integrating Fossil in the</a></li>
107	110	<li><a href="fiveminutes.wiki">Minutes as a Single User — Update and Running in 5</a></li>
108	111	<li><a href="checkin_names.wiki">Names — Checkin And Version</a></li>
	112	+<li><a href="adding_code.wiki">New Features To Fossil — Adding</a></li>
109	113	<li><a href="newrepo.wiki">New Fossil Repository — How To Create A</a></li>
110	114	<li><a href="foss-cklist.wiki">Open-Source Projects — Checklist For Successful</a></li>
111	115	<li><a href="pop.wiki">Operations — Principles Of</a></li>
112	116	<li><a href="tech_overview.wiki">Overview Of The Design And Implementation Of Fossil — A Technical</a></li>
113	117	<li><a href="index.wiki">Page — Home</a></li>
114	118

	--- www/permutedindex.wiki
	+++ www/permutedindex.wiki
	@@ -13,10 +13,11 @@
13	<h2>Permuted Index:</h2>
14	<ul>
15	<li><a href="fiveminutes.wiki">5 Minutes as a Single User — Update and Running in</a></li>
16	<li><a href="fossil-from-msvc.wiki">2010 IDE — Integrating Fossil in the Microsoft Express</a></li>
17	<li><a href="tech_overview.wiki">A Technical Overview Of The Design And Implementation Of Fossil</a></li>

18	<li><a href="antibot.wiki">against Spiders and Bots — Defense</a></li>
19	<li><a href="copyright-release.html">Agreement — Contributor License</a></li>
20	<li><a href="delta_encoder_algorithm.wiki">Algorithm — Fossil Delta Encoding</a></li>
21	<li><a href="fiveminutes.wiki">as a Single User — Update and Running in 5 Minutes</a></li>
22	<li><a href="faq.wiki">Asked Questions — Frequently</a></li>
	@@ -61,10 +62,11 @@
61	<li><a href="embeddeddoc.wiki">Embedded Project Documentation</a></li>
62	<li><a href="delta_encoder_algorithm.wiki">Encoding Algorithm — Fossil Delta</a></li>
63	<li><a href="event.wiki">Events</a></li>
64	<li><a href="inout.wiki">Export To And From Git — Import And</a></li>
65	<li><a href="fossil-from-msvc.wiki">Express 2010 IDE — Integrating Fossil in the Microsoft</a></li>

66	<li><a href="fileformat.wiki">File Format — Fossil</a></li>
67	<li><a href="branching.wiki">Forking, Merging, and Tagging — Branching,</a></li>
68	<li><a href="delta_format.wiki">Format — Fossil Delta</a></li>
69	<li><a href="fileformat.wiki">Format — Fossil File</a></li>
70	<li><a href="changes.wiki">Fossil Changelog</a></li>
	@@ -86,10 +88,11 @@
86	<li><a href="fossil-v-git.wiki">Git — Fossil Versus</a></li>
87	<li><a href="inout.wiki">Git — Import And Export To And From</a></li>
88	<li><a href="quotes.wiki">Git, and DVCSes in General — Quotes: What People Are Saying About Fossil,</a></li>
89	<li><a href="quickstart.wiki">Guide — Fossil Quick Start</a></li>
90	<li><a href="style.wiki">Guidelines — Source Code Style</a></li>

91	<li><a href="hints.wiki">Hints — Fossil Tips And Usage</a></li>
92	<li><a href="index.wiki">Home Page</a></li>
93	<li><a href="selfhost.wiki">Hosting Repositories — Fossil Self</a></li>
94	<li><a href="server.wiki">How To Configure A Fossil Server</a></li>
95	<li><a href="newrepo.wiki">How To Create A New Fossil Repository</a></li>
	@@ -104,10 +107,11 @@
104	<li><a href="password.wiki">Management And Authentication — Password</a></li>
105	<li><a href="branching.wiki">Merging, and Tagging — Branching, Forking,</a></li>
106	<li><a href="fossil-from-msvc.wiki">Microsoft Express 2010 IDE — Integrating Fossil in the</a></li>
107	<li><a href="fiveminutes.wiki">Minutes as a Single User — Update and Running in 5</a></li>
108	<li><a href="checkin_names.wiki">Names — Checkin And Version</a></li>

109	<li><a href="newrepo.wiki">New Fossil Repository — How To Create A</a></li>
110	<li><a href="foss-cklist.wiki">Open-Source Projects — Checklist For Successful</a></li>
111	<li><a href="pop.wiki">Operations — Principles Of</a></li>
112	<li><a href="tech_overview.wiki">Overview Of The Design And Implementation Of Fossil — A Technical</a></li>
113	<li><a href="index.wiki">Page — Home</a></li>
114

	--- www/permutedindex.wiki
	+++ www/permutedindex.wiki
	@@ -13,10 +13,11 @@
13	<h2>Permuted Index:</h2>
14	<ul>
15	<li><a href="fiveminutes.wiki">5 Minutes as a Single User — Update and Running in</a></li>
16	<li><a href="fossil-from-msvc.wiki">2010 IDE — Integrating Fossil in the Microsoft Express</a></li>
17	<li><a href="tech_overview.wiki">A Technical Overview Of The Design And Implementation Of Fossil</a></li>
18	<li><a href="adding_code.wiki">Adding New Features To Fossil</a></li>
19	<li><a href="antibot.wiki">against Spiders and Bots — Defense</a></li>
20	<li><a href="copyright-release.html">Agreement — Contributor License</a></li>
21	<li><a href="delta_encoder_algorithm.wiki">Algorithm — Fossil Delta Encoding</a></li>
22	<li><a href="fiveminutes.wiki">as a Single User — Update and Running in 5 Minutes</a></li>
23	<li><a href="faq.wiki">Asked Questions — Frequently</a></li>
	@@ -61,10 +62,11 @@
62	<li><a href="embeddeddoc.wiki">Embedded Project Documentation</a></li>
63	<li><a href="delta_encoder_algorithm.wiki">Encoding Algorithm — Fossil Delta</a></li>
64	<li><a href="event.wiki">Events</a></li>
65	<li><a href="inout.wiki">Export To And From Git — Import And</a></li>
66	<li><a href="fossil-from-msvc.wiki">Express 2010 IDE — Integrating Fossil in the Microsoft</a></li>
67	<li><a href="adding_code.wiki">Features To Fossil — Adding New</a></li>
68	<li><a href="fileformat.wiki">File Format — Fossil</a></li>
69	<li><a href="branching.wiki">Forking, Merging, and Tagging — Branching,</a></li>
70	<li><a href="delta_format.wiki">Format — Fossil Delta</a></li>
71	<li><a href="fileformat.wiki">Format — Fossil File</a></li>
72	<li><a href="changes.wiki">Fossil Changelog</a></li>
	@@ -86,10 +88,11 @@
88	<li><a href="fossil-v-git.wiki">Git — Fossil Versus</a></li>
89	<li><a href="inout.wiki">Git — Import And Export To And From</a></li>
90	<li><a href="quotes.wiki">Git, and DVCSes in General — Quotes: What People Are Saying About Fossil,</a></li>
91	<li><a href="quickstart.wiki">Guide — Fossil Quick Start</a></li>
92	<li><a href="style.wiki">Guidelines — Source Code Style</a></li>
93	<li><a href="adding_code.wiki">Hacking Fossil</a></li>
94	<li><a href="hints.wiki">Hints — Fossil Tips And Usage</a></li>
95	<li><a href="index.wiki">Home Page</a></li>
96	<li><a href="selfhost.wiki">Hosting Repositories — Fossil Self</a></li>
97	<li><a href="server.wiki">How To Configure A Fossil Server</a></li>
98	<li><a href="newrepo.wiki">How To Create A New Fossil Repository</a></li>
	@@ -104,10 +107,11 @@
107	<li><a href="password.wiki">Management And Authentication — Password</a></li>
108	<li><a href="branching.wiki">Merging, and Tagging — Branching, Forking,</a></li>
109	<li><a href="fossil-from-msvc.wiki">Microsoft Express 2010 IDE — Integrating Fossil in the</a></li>
110	<li><a href="fiveminutes.wiki">Minutes as a Single User — Update and Running in 5</a></li>
111	<li><a href="checkin_names.wiki">Names — Checkin And Version</a></li>
112	<li><a href="adding_code.wiki">New Features To Fossil — Adding</a></li>
113	<li><a href="newrepo.wiki">New Fossil Repository — How To Create A</a></li>
114	<li><a href="foss-cklist.wiki">Open-Source Projects — Checklist For Successful</a></li>
115	<li><a href="pop.wiki">Operations — Principles Of</a></li>
116	<li><a href="tech_overview.wiki">Overview Of The Design And Implementation Of Fossil — A Technical</a></li>
117	<li><a href="index.wiki">Page — Home</a></li>
118

M www/tech_overview.wiki

		--- www/tech_overview.wiki
		+++ www/tech_overview.wiki
		@@ -332,5 +332,11 @@
332	332
333	333	Note that the stash, the undo stack, and the state of the bisect command
334	334	are all contained within the checkout database. That means that the
335	335	fossil close command will delete all stash content, the undo stack, and
336	336	the bisect state. The close command is not undoable. Use it with care.
	337	+
	338	+<h2>3.0 See Also</h2>
	339	+
	340	+ * [./makefile.wiki \| The Fossil Build Process]
	341	+ * [./contribute.wiki \| How To Contribute Code To Fossil]
	342	+ * [./adding_code.wiki \| Adding New Features To Fossil]
337	343

	--- www/tech_overview.wiki
	+++ www/tech_overview.wiki
	@@ -332,5 +332,11 @@
332
333	Note that the stash, the undo stack, and the state of the bisect command
334	are all contained within the checkout database. That means that the
335	fossil close command will delete all stash content, the undo stack, and
336	the bisect state. The close command is not undoable. Use it with care.






337

	--- www/tech_overview.wiki
	+++ www/tech_overview.wiki
	@@ -332,5 +332,11 @@
332
333	Note that the stash, the undo stack, and the state of the bisect command
334	are all contained within the checkout database. That means that the
335	fossil close command will delete all stash content, the undo stack, and
336	the bisect state. The close command is not undoable. Use it with care.
337
338	<h2>3.0 See Also</h2>
339
340	* [./makefile.wiki \| The Fossil Build Process]
341	* [./contribute.wiki \| How To Contribute Code To Fossil]
342	* [./adding_code.wiki \| Adding New Features To Fossil]
343

Fossil SCM

Keyboard Shortcuts