Fossil

Check-in [49cbf5e5]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Fix documentation typos.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1:49cbf5e519b9c10f93e6df34106bbff6d26f2101
User & Date: drh 2011-02-07 14:35:12
Context
2011-02-07
18:02
Ignore duplicate tags when interpreting git-fast-export text for import. check-in: 355bd996 user: drh tags: trunk
17:51
Merge latest trunk. check-in: d7d335a6 user: dmitry tags: symlinks
14:35
Fix documentation typos. check-in: 49cbf5e5 user: drh tags: trunk
14:34
Enhance the graph generator so that it uses less memory and so that it is not limited to a fixed number of parents (10) for each node. check-in: 5ee80c54 user: drh tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to www/checkin_names.wiki.

1
2
3
4
5
6
7
8
9
10
11
...
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
<title>Check-in Names</title>

Many Fossil commands and [./webui.wiki | web-interface] URLs accept
check-in names as an argument.  For example, the "info" command
accepts an optional check-in name to identify the specific checkout
about which information is desired:

<blockquote>
<tt>fossil info</tt> <i>checkin-name</i>
</blockquote>

................................................................................
The space between the day and the year can optionally be 
replaced by an uppercase <b>T</b> and the entire timestamp can
optionally be followed by "<b>utc</b>".

In its default configuration, Fossil interprets and displays all dates
in Universal Coordinated Time (UTC).  This tends to work the best for
distributed projects where participants are scattered around the globe.
But there is an open on the Admin/Timeline page of the web-interface to
switch to local time.  The "<b>utc</b>" suffix on an timestamp check-in
name is meaningless if Fossil is in the default mode of using UTC for
everything, but if Fossil has been switched to localtime mode, then the
"<b>utc</b>" suffix means to interpret that particular timestamp using 
UTC instead localtime.

As an example, consider the homepage for the Fossil website itself:


|
|







 







|







1
2
3
4
5
6
7
8
9
10
11
...
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
<title>Check-in Names</title>

Many Fossil [/help|commands] and [./webui.wiki | web-interface] URLs accept
check-in names as an argument.  For example, the "[/help/info|info]" command
accepts an optional check-in name to identify the specific checkout
about which information is desired:

<blockquote>
<tt>fossil info</tt> <i>checkin-name</i>
</blockquote>

................................................................................
The space between the day and the year can optionally be 
replaced by an uppercase <b>T</b> and the entire timestamp can
optionally be followed by "<b>utc</b>".

In its default configuration, Fossil interprets and displays all dates
in Universal Coordinated Time (UTC).  This tends to work the best for
distributed projects where participants are scattered around the globe.
But there is an option on the Admin/Timeline page of the web-interface to
switch to local time.  The "<b>utc</b>" suffix on an timestamp check-in
name is meaningless if Fossil is in the default mode of using UTC for
everything, but if Fossil has been switched to localtime mode, then the
"<b>utc</b>" suffix means to interpret that particular timestamp using 
UTC instead localtime.

As an example, consider the homepage for the Fossil website itself:

Changes to www/makefile.wiki.

83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
...
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
should understand that whenever "src.c" or "src.h" is used in the text
that follows, we really mean all (79) other source files other than
the exceptions described above.

<h1>3.0 Automatically generated files</h1>

The "VERSION.h" header file contains some C preprocessor macros that
identify the version of Fossil that is to be build.  The VERSION.h file
generated automatically from information extracted from the "manifest"
and "manifest.uuid" source files in the root directory of the source tree.
(The "manifest" and "manifest.uuid" files are automatically generated and
updated by Fossil itself.  See the [/help/setting | fossil set manifest]
command for additional information.)

Under unix, there is an AWK script that converts manifest and manifest.uuid
................................................................................
in the root of the source tree are the first two arguments and the name of
the generated VERSION.h file is the third and final argument.

<h1>4.0 Preprocessing</h1>

There are three preprocessors for the Fossil sources.  The mkindex
and translate preprocessors can be run in any order.  The makeheaders
preprocessor has to be run after translate.

<h2>4.1 The mkindex preprocessor</h2>

The mkindex program scans the "src.c" source files looking for special
comments that identify routines that implement of various Fossil commands,
web interface methods, and help text comments.  The mkindex program
generates some C code that Fossil uses in order to dispatch commands and







|







 







|







83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
...
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
should understand that whenever "src.c" or "src.h" is used in the text
that follows, we really mean all (79) other source files other than
the exceptions described above.

<h1>3.0 Automatically generated files</h1>

The "VERSION.h" header file contains some C preprocessor macros that
identify the version of Fossil that is to be build.  The VERSION.h file is
generated automatically from information extracted from the "manifest"
and "manifest.uuid" source files in the root directory of the source tree.
(The "manifest" and "manifest.uuid" files are automatically generated and
updated by Fossil itself.  See the [/help/setting | fossil set manifest]
command for additional information.)

Under unix, there is an AWK script that converts manifest and manifest.uuid
................................................................................
in the root of the source tree are the first two arguments and the name of
the generated VERSION.h file is the third and final argument.

<h1>4.0 Preprocessing</h1>

There are three preprocessors for the Fossil sources.  The mkindex
and translate preprocessors can be run in any order.  The makeheaders
preprocessor must be run after translate.

<h2>4.1 The mkindex preprocessor</h2>

The mkindex program scans the "src.c" source files looking for special
comments that identify routines that implement of various Fossil commands,
web interface methods, and help text comments.  The mkindex program
generates some C code that Fossil uses in order to dispatch commands and