Fossil SCM

Try to make it easier for people to find the documentation on how to add new commands to the Fossil core.

drh 2020-03-18 14:56 trunk

Commit 29c3e99d7388c8461ab2334f41ca6bdd1934e30725eefa1bd47fca8dcee151ae

Parent 2233a7b7ac48c5f…

4 files changed +2 +3 -3 +2 -1 +4 -1

~ www/adding_code.wiki ~ www/hacker-howto.wiki ~ www/mkindex.tcl ~ www/permutedindex.html

M www/adding_code.wiki

		--- www/adding_code.wiki
		+++ www/adding_code.wiki
		@@ -102,10 +102,11 @@
102	102	It is recommended that you try this.
103	103
104	104	Be sure to [/help/add\|fossil add] your new source file to the self-hosting
105	105	Fossil repository and then [/help/commit\|commit] your changes!
106	106
	107	+<a name="newcmd"></a>
107	108	<h2>4.0 Creating A New Command</h2>
108	109
109	110	By "commands" we mean the keywords that follow "fossil" when invoking
110	111	Fossil from the command-line. So, for example, in
111	112
		@@ -167,10 +168,11 @@
167	168	the working check-out. Study implementations of existing commands
168	169	to get an idea of how things are done. You can easily find the implementations
169	170	of existing commands by searching for "COMMAND: <i>name</i>" in the
170	171	files of the "src/" directory.
171	172
	173	+<a name="newpage"></a>
172	174	<h2>5.0 Creating A New Web Page</h2>
173	175
174	176	As with commands, new webpages can be added simply by inserting a function
175	177	that generates the webpage together with a special header comment. A
176	178	template follows:
177	179

	--- www/adding_code.wiki
	+++ www/adding_code.wiki
	@@ -102,10 +102,11 @@
102	It is recommended that you try this.
103
104	Be sure to [/help/add\|fossil add] your new source file to the self-hosting
105	Fossil repository and then [/help/commit\|commit] your changes!
106

107	<h2>4.0 Creating A New Command</h2>
108
109	By "commands" we mean the keywords that follow "fossil" when invoking
110	Fossil from the command-line. So, for example, in
111
	@@ -167,10 +168,11 @@
167	the working check-out. Study implementations of existing commands
168	to get an idea of how things are done. You can easily find the implementations
169	of existing commands by searching for "COMMAND: <i>name</i>" in the
170	files of the "src/" directory.
171

172	<h2>5.0 Creating A New Web Page</h2>
173
174	As with commands, new webpages can be added simply by inserting a function
175	that generates the webpage together with a special header comment. A
176	template follows:
177

	--- www/adding_code.wiki
	+++ www/adding_code.wiki
	@@ -102,10 +102,11 @@
102	It is recommended that you try this.
103
104	Be sure to [/help/add\|fossil add] your new source file to the self-hosting
105	Fossil repository and then [/help/commit\|commit] your changes!
106
107	<a name="newcmd"></a>
108	<h2>4.0 Creating A New Command</h2>
109
110	By "commands" we mean the keywords that follow "fossil" when invoking
111	Fossil from the command-line. So, for example, in
112
	@@ -167,10 +168,11 @@
168	the working check-out. Study implementations of existing commands
169	to get an idea of how things are done. You can easily find the implementations
170	of existing commands by searching for "COMMAND: <i>name</i>" in the
171	files of the "src/" directory.
172
173	<a name="newpage"></a>
174	<h2>5.0 Creating A New Web Page</h2>
175
176	As with commands, new webpages can be added simply by inserting a function
177	that generates the webpage together with a special header comment. A
178	template follows:
179

M www/hacker-howto.wiki

+3 -3

		--- www/hacker-howto.wiki
		+++ www/hacker-howto.wiki
		@@ -1,15 +1,15 @@
1		-<title>Fossil Hackers How-To</title>
	1	+<title>Fossil Developer How-To</title>
2	2
3	3	The following links are of interest to programmers who want to modify
4		-or enhance Fossil. Ordinary users can safely ignore this information.
	4	+or enhance Fossil itself. Ordinary users can safely ignore this information.
5	5
6	6	* [./build.wiki \| How To Compile And Install Fossil]
7	7	* [./customskin.md \| Theming Fossil]
	8	+ * [./adding_code.wiki#newcmd \| Adding New Commands To Fossil]
8	9	* [./makefile.wiki \| The Fossil Build Process]
9	10	* [./tech_overview.wiki \| A Technical Overview of Fossil]
10		- * [./adding_code.wiki \| Adding Features To Fossil]
11	11	* [./contribute.wiki\|Contributing Code Or Enhancements To The Fossil Project]
12	12	* [./fileformat.wiki\|Fossil Artifact File Format]
13	13	* [./sync.wiki\|The Sync Protocol]
14	14	* [./style.wiki \| Coding Style Guidelines]
15	15	* [./checkin.wiki \| Pre-checkin Checklist]
16	16

	--- www/hacker-howto.wiki
	+++ www/hacker-howto.wiki
	@@ -1,15 +1,15 @@
1	<title>Fossil Hackers How-To</title>
2
3	The following links are of interest to programmers who want to modify
4	or enhance Fossil. Ordinary users can safely ignore this information.
5
6	* [./build.wiki \| How To Compile And Install Fossil]
7	* [./customskin.md \| Theming Fossil]

8	* [./makefile.wiki \| The Fossil Build Process]
9	* [./tech_overview.wiki \| A Technical Overview of Fossil]
10	* [./adding_code.wiki \| Adding Features To Fossil]
11	* [./contribute.wiki\|Contributing Code Or Enhancements To The Fossil Project]
12	* [./fileformat.wiki\|Fossil Artifact File Format]
13	* [./sync.wiki\|The Sync Protocol]
14	* [./style.wiki \| Coding Style Guidelines]
15	* [./checkin.wiki \| Pre-checkin Checklist]
16

	--- www/hacker-howto.wiki
	+++ www/hacker-howto.wiki
	@@ -1,15 +1,15 @@
1	<title>Fossil Developer How-To</title>
2
3	The following links are of interest to programmers who want to modify
4	or enhance Fossil itself. Ordinary users can safely ignore this information.
5
6	* [./build.wiki \| How To Compile And Install Fossil]
7	* [./customskin.md \| Theming Fossil]
8	* [./adding_code.wiki#newcmd \| Adding New Commands To Fossil]
9	* [./makefile.wiki \| The Fossil Build Process]
10	* [./tech_overview.wiki \| A Technical Overview of Fossil]

11	* [./contribute.wiki\|Contributing Code Or Enhancements To The Fossil Project]
12	* [./fileformat.wiki\|Fossil Artifact File Format]
13	* [./sync.wiki\|The Sync Protocol]
14	* [./style.wiki \| Coding Style Guidelines]
15	* [./checkin.wiki \| Pre-checkin Checklist]
16

M www/mkindex.tcl

+2 -1

		--- www/mkindex.tcl
		+++ www/mkindex.tcl
		@@ -50,10 +50,11 @@
50	50	fossil_prompt.wiki {Fossilized Bash Prompt}
51	51	fossil-v-git.wiki {Fossil Versus Git}
52	52	globs.md {File Name Glob Patterns}
53	53	grep.md {Fossil grep vs POSIX grep}
54	54	hacker-howto.wiki {Hacker How-To}
	55	+ hacker-howto.wiki {Fossil Developers Guide}
55	56	hashpolicy.wiki {Hash Policy: Choosing Between SHA1 and SHA3-256}
56	57	/help {Lists of Commands and Webpages}
57	58	hints.wiki {Fossil Tips And Usage Hints}
58	59	index.wiki {Home Page}
59	60	inout.wiki {Import And Export To And From Git}
		@@ -139,11 +140,11 @@
139	140	<li> <a href='build.wiki'>Compiling and installing Fossil</a>
140	141	<li> <a href='../COPYRIGHT-BSD2.txt'>License</a>
141	142	<li> <a href='http://www.fossil-scm.org/schimpf-book/home'>Jim Schimpf's
142	143	book</a>
143	144	<li> <a href='$ROOT/help'>List of commands, web-pages, and settings</a>
144		-<li> <a href='hacker-howto.wiki'>Hacker How-To</a>
	145	+<li> <a href='hacker-howto.wiki'>Fossil Developer's Guide</a>
145	146	</ul>
146	147	<a name="pindex"></a>
147	148	<h2>Permuted Index:</h2>
148	149	<ul>}
149	150	foreach entry $permindex {
150	151

	--- www/mkindex.tcl
	+++ www/mkindex.tcl
	@@ -50,10 +50,11 @@
50	fossil_prompt.wiki {Fossilized Bash Prompt}
51	fossil-v-git.wiki {Fossil Versus Git}
52	globs.md {File Name Glob Patterns}
53	grep.md {Fossil grep vs POSIX grep}
54	hacker-howto.wiki {Hacker How-To}

55	hashpolicy.wiki {Hash Policy: Choosing Between SHA1 and SHA3-256}
56	/help {Lists of Commands and Webpages}
57	hints.wiki {Fossil Tips And Usage Hints}
58	index.wiki {Home Page}
59	inout.wiki {Import And Export To And From Git}
	@@ -139,11 +140,11 @@
139	<li> <a href='build.wiki'>Compiling and installing Fossil</a>
140	<li> <a href='../COPYRIGHT-BSD2.txt'>License</a>
141	<li> <a href='http://www.fossil-scm.org/schimpf-book/home'>Jim Schimpf's
142	book</a>
143	<li> <a href='$ROOT/help'>List of commands, web-pages, and settings</a>
144	<li> <a href='hacker-howto.wiki'>Hacker How-To</a>
145	</ul>
146	<a name="pindex"></a>
147	<h2>Permuted Index:</h2>
148	<ul>}
149	foreach entry $permindex {
150

	--- www/mkindex.tcl
	+++ www/mkindex.tcl
	@@ -50,10 +50,11 @@
50	fossil_prompt.wiki {Fossilized Bash Prompt}
51	fossil-v-git.wiki {Fossil Versus Git}
52	globs.md {File Name Glob Patterns}
53	grep.md {Fossil grep vs POSIX grep}
54	hacker-howto.wiki {Hacker How-To}
55	hacker-howto.wiki {Fossil Developers Guide}
56	hashpolicy.wiki {Hash Policy: Choosing Between SHA1 and SHA3-256}
57	/help {Lists of Commands and Webpages}
58	hints.wiki {Fossil Tips And Usage Hints}
59	index.wiki {Home Page}
60	inout.wiki {Import And Export To And From Git}
	@@ -139,11 +140,11 @@
140	<li> <a href='build.wiki'>Compiling and installing Fossil</a>
141	<li> <a href='../COPYRIGHT-BSD2.txt'>License</a>
142	<li> <a href='http://www.fossil-scm.org/schimpf-book/home'>Jim Schimpf's
143	book</a>
144	<li> <a href='$ROOT/help'>List of commands, web-pages, and settings</a>
145	<li> <a href='hacker-howto.wiki'>Fossil Developer's Guide</a>
146	</ul>
147	<a name="pindex"></a>
148	<h2>Permuted Index:</h2>
149	<ul>}
150	foreach entry $permindex {
151

M www/permutedindex.html

+4 -1

		--- www/permutedindex.html
		+++ www/permutedindex.html
		@@ -13,11 +13,11 @@
13	13	<li> <a href='build.wiki'>Compiling and installing Fossil</a>
14	14	<li> <a href='../COPYRIGHT-BSD2.txt'>License</a>
15	15	<li> <a href='http://www.fossil-scm.org/schimpf-book/home'>Jim Schimpf's
16	16	book</a>
17	17	<li> <a href='$ROOT/help'>List of commands, web-pages, and settings</a>
18		-<li> <a href='hacker-howto.wiki'>Hacker How-To</a>
	18	+<li> <a href='hacker-howto.wiki'>Fossil Developer's Guide</a>
19	19	</ul>
20	20	<a name="pindex"></a>
21	21	<h2>Permuted Index:</h2>
22	22	<ul>
23	23	<li><a href="fiveminutes.wiki">5 Minutes as a Single User — Up and Running in</a></li>
		@@ -89,10 +89,11 @@
89	89	<li><a href="private.wiki">Deleting Private Branches — Creating, Syncing, and</a></li>
90	90	<li><a href="delta_encoder_algorithm.wiki">Delta Encoding Algorithm — Fossil</a></li>
91	91	<li><a href="delta_format.wiki">Delta Format — Fossil</a></li>
92	92	<li><a href="tech_overview.wiki">Design And Implementation Of Fossil — A Technical Overview Of The</a></li>
93	93	<li><a href="theory1.wiki">Design Of The Fossil DVCS — Thoughts On The</a></li>
	94	+<li><a href="hacker-howto.wiki">Developers Guide — Fossil</a></li>
94	95	<li><a href="caps/admin-v-setup.md"><b>Differences Between Setup and Admin Users</b></a></li>
95	96	<li><a href="embeddeddoc.wiki">Documentation — Embedded Project</a></li>
96	97	<li><a href="contribute.wiki">Documentation To The Fossil Project — Contributing Code or</a></li>
97	98	<li><a href="aboutdownload.wiki">Download Page Works — How The</a></li>
98	99	<li><a href="theory1.wiki">DVCS — Thoughts On The Design Of The Fossil</a></li>
		@@ -122,10 +123,11 @@
122	123	<li><a href="blockchain.md"><b>Fossil As Blockchain</b></a></li>
123	124	<li><a href="changes.wiki"><b>Fossil Changelog</b></a></li>
124	125	<li><a href="concepts.wiki"><b>Fossil Core Concepts</b></a></li>
125	126	<li><a href="delta_encoder_algorithm.wiki"><b>Fossil Delta Encoding Algorithm</b></a></li>
126	127	<li><a href="delta_format.wiki"><b>Fossil Delta Format</b></a></li>
	128	+<li><a href="hacker-howto.wiki"><b>Fossil Developers Guide</b></a></li>
127	129	<li><a href="fileformat.wiki"><b>Fossil File Format</b></a></li>
128	130	<li><a href="forum.wiki"><b>Fossil Forums</b></a></li>
129	131	<li><a href="grep.md"><b>Fossil grep vs POSIX grep</b></a></li>
130	132	<li><a href="quickstart.wiki"><b>Fossil Quick Start Guide</b></a></li>
131	133	<li><a href="selfcheck.wiki"><b>Fossil Repository Integrity Self Checks</b></a></li>
		@@ -145,10 +147,11 @@
145	147	<li><a href="globs.md">Glob Patterns — File Name</a></li>
146	148	<li><a href="env-opts.md">Global Options — Environment Variables and</a></li>
147	149	<li><a href="customgraph.md">Graph — Theming: Customizing the Timeline</a></li>
148	150	<li><a href="grep.md">grep — Fossil grep vs POSIX</a></li>
149	151	<li><a href="grep.md">grep vs POSIX grep — Fossil</a></li>
	152	+<li><a href="hacker-howto.wiki">Guide — Fossil Developers</a></li>
150	153	<li><a href="quickstart.wiki">Guide — Fossil Quick Start</a></li>
151	154	<li><a href="style.wiki">Guidelines — Source Code Style</a></li>
152	155	<li><a href="hacker-howto.wiki"><b>Hacker How-To</b></a></li>
153	156	<li><a href="adding_code.wiki"><b>Hacking Fossil</b></a></li>
154	157	<li><a href="rebaseharm.md">Harmful — Rebase Considered</a></li>
155	158

	--- www/permutedindex.html
	+++ www/permutedindex.html
	@@ -13,11 +13,11 @@
13	<li> <a href='build.wiki'>Compiling and installing Fossil</a>
14	<li> <a href='../COPYRIGHT-BSD2.txt'>License</a>
15	<li> <a href='http://www.fossil-scm.org/schimpf-book/home'>Jim Schimpf's
16	book</a>
17	<li> <a href='$ROOT/help'>List of commands, web-pages, and settings</a>
18	<li> <a href='hacker-howto.wiki'>Hacker How-To</a>
19	</ul>
20	<a name="pindex"></a>
21	<h2>Permuted Index:</h2>
22	<ul>
23	<li><a href="fiveminutes.wiki">5 Minutes as a Single User — Up and Running in</a></li>
	@@ -89,10 +89,11 @@
89	<li><a href="private.wiki">Deleting Private Branches — Creating, Syncing, and</a></li>
90	<li><a href="delta_encoder_algorithm.wiki">Delta Encoding Algorithm — Fossil</a></li>
91	<li><a href="delta_format.wiki">Delta Format — Fossil</a></li>
92	<li><a href="tech_overview.wiki">Design And Implementation Of Fossil — A Technical Overview Of The</a></li>
93	<li><a href="theory1.wiki">Design Of The Fossil DVCS — Thoughts On The</a></li>

94	<li><a href="caps/admin-v-setup.md"><b>Differences Between Setup and Admin Users</b></a></li>
95	<li><a href="embeddeddoc.wiki">Documentation — Embedded Project</a></li>
96	<li><a href="contribute.wiki">Documentation To The Fossil Project — Contributing Code or</a></li>
97	<li><a href="aboutdownload.wiki">Download Page Works — How The</a></li>
98	<li><a href="theory1.wiki">DVCS — Thoughts On The Design Of The Fossil</a></li>
	@@ -122,10 +123,11 @@
122	<li><a href="blockchain.md"><b>Fossil As Blockchain</b></a></li>
123	<li><a href="changes.wiki"><b>Fossil Changelog</b></a></li>
124	<li><a href="concepts.wiki"><b>Fossil Core Concepts</b></a></li>
125	<li><a href="delta_encoder_algorithm.wiki"><b>Fossil Delta Encoding Algorithm</b></a></li>
126	<li><a href="delta_format.wiki"><b>Fossil Delta Format</b></a></li>

127	<li><a href="fileformat.wiki"><b>Fossil File Format</b></a></li>
128	<li><a href="forum.wiki"><b>Fossil Forums</b></a></li>
129	<li><a href="grep.md"><b>Fossil grep vs POSIX grep</b></a></li>
130	<li><a href="quickstart.wiki"><b>Fossil Quick Start Guide</b></a></li>
131	<li><a href="selfcheck.wiki"><b>Fossil Repository Integrity Self Checks</b></a></li>
	@@ -145,10 +147,11 @@
145	<li><a href="globs.md">Glob Patterns — File Name</a></li>
146	<li><a href="env-opts.md">Global Options — Environment Variables and</a></li>
147	<li><a href="customgraph.md">Graph — Theming: Customizing the Timeline</a></li>
148	<li><a href="grep.md">grep — Fossil grep vs POSIX</a></li>
149	<li><a href="grep.md">grep vs POSIX grep — Fossil</a></li>

150	<li><a href="quickstart.wiki">Guide — Fossil Quick Start</a></li>
151	<li><a href="style.wiki">Guidelines — Source Code Style</a></li>
152	<li><a href="hacker-howto.wiki"><b>Hacker How-To</b></a></li>
153	<li><a href="adding_code.wiki"><b>Hacking Fossil</b></a></li>
154	<li><a href="rebaseharm.md">Harmful — Rebase Considered</a></li>
155

	--- www/permutedindex.html
	+++ www/permutedindex.html
	@@ -13,11 +13,11 @@
13	<li> <a href='build.wiki'>Compiling and installing Fossil</a>
14	<li> <a href='../COPYRIGHT-BSD2.txt'>License</a>
15	<li> <a href='http://www.fossil-scm.org/schimpf-book/home'>Jim Schimpf's
16	book</a>
17	<li> <a href='$ROOT/help'>List of commands, web-pages, and settings</a>
18	<li> <a href='hacker-howto.wiki'>Fossil Developer's Guide</a>
19	</ul>
20	<a name="pindex"></a>
21	<h2>Permuted Index:</h2>
22	<ul>
23	<li><a href="fiveminutes.wiki">5 Minutes as a Single User — Up and Running in</a></li>
	@@ -89,10 +89,11 @@
89	<li><a href="private.wiki">Deleting Private Branches — Creating, Syncing, and</a></li>
90	<li><a href="delta_encoder_algorithm.wiki">Delta Encoding Algorithm — Fossil</a></li>
91	<li><a href="delta_format.wiki">Delta Format — Fossil</a></li>
92	<li><a href="tech_overview.wiki">Design And Implementation Of Fossil — A Technical Overview Of The</a></li>
93	<li><a href="theory1.wiki">Design Of The Fossil DVCS — Thoughts On The</a></li>
94	<li><a href="hacker-howto.wiki">Developers Guide — Fossil</a></li>
95	<li><a href="caps/admin-v-setup.md"><b>Differences Between Setup and Admin Users</b></a></li>
96	<li><a href="embeddeddoc.wiki">Documentation — Embedded Project</a></li>
97	<li><a href="contribute.wiki">Documentation To The Fossil Project — Contributing Code or</a></li>
98	<li><a href="aboutdownload.wiki">Download Page Works — How The</a></li>
99	<li><a href="theory1.wiki">DVCS — Thoughts On The Design Of The Fossil</a></li>
	@@ -122,10 +123,11 @@
123	<li><a href="blockchain.md"><b>Fossil As Blockchain</b></a></li>
124	<li><a href="changes.wiki"><b>Fossil Changelog</b></a></li>
125	<li><a href="concepts.wiki"><b>Fossil Core Concepts</b></a></li>
126	<li><a href="delta_encoder_algorithm.wiki"><b>Fossil Delta Encoding Algorithm</b></a></li>
127	<li><a href="delta_format.wiki"><b>Fossil Delta Format</b></a></li>
128	<li><a href="hacker-howto.wiki"><b>Fossil Developers Guide</b></a></li>
129	<li><a href="fileformat.wiki"><b>Fossil File Format</b></a></li>
130	<li><a href="forum.wiki"><b>Fossil Forums</b></a></li>
131	<li><a href="grep.md"><b>Fossil grep vs POSIX grep</b></a></li>
132	<li><a href="quickstart.wiki"><b>Fossil Quick Start Guide</b></a></li>
133	<li><a href="selfcheck.wiki"><b>Fossil Repository Integrity Self Checks</b></a></li>
	@@ -145,10 +147,11 @@
147	<li><a href="globs.md">Glob Patterns — File Name</a></li>
148	<li><a href="env-opts.md">Global Options — Environment Variables and</a></li>
149	<li><a href="customgraph.md">Graph — Theming: Customizing the Timeline</a></li>
150	<li><a href="grep.md">grep — Fossil grep vs POSIX</a></li>
151	<li><a href="grep.md">grep vs POSIX grep — Fossil</a></li>
152	<li><a href="hacker-howto.wiki">Guide — Fossil Developers</a></li>
153	<li><a href="quickstart.wiki">Guide — Fossil Quick Start</a></li>
154	<li><a href="style.wiki">Guidelines — Source Code Style</a></li>
155	<li><a href="hacker-howto.wiki"><b>Hacker How-To</b></a></li>
156	<li><a href="adding_code.wiki"><b>Hacking Fossil</b></a></li>
157	<li><a href="rebaseharm.md">Harmful — Rebase Considered</a></li>
158

Fossil SCM

Keyboard Shortcuts