Fossil SCM

docs

kejoki 2008-12-16 05:16 trunk
Commit a9dcbf3ede5a7431659aad4956155b6846fa42d3
--- a/www/cmd_changes.wiki
+++ b/www/cmd_changes.wiki
@@ -0,0 +1,19 @@
1
+<h2>changes</h2>
2
+
3
+The <code>changes</code> command is informational, it doesn't do
4
+anything to a checked-out project, but it tells you something about
5
+it.
6
+
7
+This is simply a quick way to get a list of the files which are
8
+different in the source tree (the checkout) and the repository.
9
+
10
+There is a bit more information (was a file edited, added or
11
+removed?, for instance).
12
+
13
+The same information will be displayed if you
14
+[./cmd_status.wiki | <code>&nbsp;fossil&nbsp;status&nbsp;</code>],
15
+except there will be some additional repository information displayed
16
+first.
17
+
18
+See also: [./cmd_status.wiki | fossil status],
19
+[./reference.wiki | Reference]
--- a/www/cmd_changes.wiki
+++ b/www/cmd_changes.wiki
@@ -0,0 +1,19 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
--- a/www/cmd_changes.wiki
+++ b/www/cmd_changes.wiki
@@ -0,0 +1,19 @@
1 <h2>changes</h2>
2
3 The <code>changes</code> command is informational, it doesn't do
4 anything to a checked-out project, but it tells you something about
5 it.
6
7 This is simply a quick way to get a list of the files which are
8 different in the source tree (the checkout) and the repository.
9
10 There is a bit more information (was a file edited, added or
11 removed?, for instance).
12
13 The same information will be displayed if you
14 [./cmd_status.wiki | <code>&nbsp;fossil&nbsp;status&nbsp;</code>],
15 except there will be some additional repository information displayed
16 first.
17
18 See also: [./cmd_status.wiki | fossil status],
19 [./reference.wiki | Reference]
--- a/www/cmd_checkout.wiki
+++ b/www/cmd_checkout.wiki
@@ -0,0 +1,46 @@
1
+<h2>checkout</h2>
2
+
3
+The <code>checkout</code> command is how a project version goes from
4
+the repository to the chosen project directory.
5
+
6
+Without going into detail about getting/opening a repository, once you
7
+have a repository and a place in which the repository has been
8
+opened, you can "check out" a "version" of the files which make up the
9
+repository at somewhen.
10
+
11
+The term "checkout" is traditional in source management systems, but a
12
+bit of an anachronism in a distributed system like <b>fossil</b>.
13
+"Checking out" a version of a project means getting all of the source
14
+artifacts out into the standard environment---currently the
15
+shell/file-system.
16
+
17
+Traditionally, the version is some "incrementing" code like
18
+v1.3.2rcQuink or f451 or something. In distributed SCM systems it's
19
+some absolutely unique identifier, usually the result of a one-way
20
+hash (SHA1, in fossil's case.) The <b>fossil</b> term for these is
21
+<em>artifact IDs</em>.
22
+
23
+<code>fossil&nbsp;checkout&nbsp;</code> <i>id</i> will check out the
24
+version corresponding to <i>id</i> into the source tree.
25
+
26
+<code>checkout</code> requires you to pick a precise version to put into
27
+the "on-disk" source tree, and leaves any edited files which are already
28
+in the tree intact.
29
+
30
+<code>update</code>, on the other hand, <em>merges</em> edits into the
31
+version you choose (if you choose one; you can default the version.)
32
+
33
+Since a version is required, and <b>fossil</b>'s artifact IDs are
34
+fairly long, there are two good ways to refer to the version. You can
35
+use a unique proper prefix of the version (six or eight characters is
36
+more than enough in most cases) <em>or</em> you can [./cmd_tag.wiki |
37
+tag] your baselines and use the tags for checkouts, reverting,
38
+branching (tags are the best way to branch) and so forth. Both
39
+methods work throughout fossil.
40
+
41
+See also [./cmd_tag.wiki | fossil tag],
42
+[./cmd_revert.wiki | fossil revert],
43
+[./cmd_update.wiki | fossil update],
44
+[./cmd_push.wiki | fossil push],
45
+[./cmd_pull.wiki | fossil pull],
46
+[./
--- a/www/cmd_checkout.wiki
+++ b/www/cmd_checkout.wiki
@@ -0,0 +1,46 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
--- a/www/cmd_checkout.wiki
+++ b/www/cmd_checkout.wiki
@@ -0,0 +1,46 @@
1 <h2>checkout</h2>
2
3 The <code>checkout</code> command is how a project version goes from
4 the repository to the chosen project directory.
5
6 Without going into detail about getting/opening a repository, once you
7 have a repository and a place in which the repository has been
8 opened, you can "check out" a "version" of the files which make up the
9 repository at somewhen.
10
11 The term "checkout" is traditional in source management systems, but a
12 bit of an anachronism in a distributed system like <b>fossil</b>.
13 "Checking out" a version of a project means getting all of the source
14 artifacts out into the standard environment---currently the
15 shell/file-system.
16
17 Traditionally, the version is some "incrementing" code like
18 v1.3.2rcQuink or f451 or something. In distributed SCM systems it's
19 some absolutely unique identifier, usually the result of a one-way
20 hash (SHA1, in fossil's case.) The <b>fossil</b> term for these is
21 <em>artifact IDs</em>.
22
23 <code>fossil&nbsp;checkout&nbsp;</code> <i>id</i> will check out the
24 version corresponding to <i>id</i> into the source tree.
25
26 <code>checkout</code> requires you to pick a precise version to put into
27 the "on-disk" source tree, and leaves any edited files which are already
28 in the tree intact.
29
30 <code>update</code>, on the other hand, <em>merges</em> edits into the
31 version you choose (if you choose one; you can default the version.)
32
33 Since a version is required, and <b>fossil</b>'s artifact IDs are
34 fairly long, there are two good ways to refer to the version. You can
35 use a unique proper prefix of the version (six or eight characters is
36 more than enough in most cases) <em>or</em> you can [./cmd_tag.wiki |
37 tag] your baselines and use the tags for checkouts, reverting,
38 branching (tags are the best way to branch) and so forth. Both
39 methods work throughout fossil.
40
41 See also [./cmd_tag.wiki | fossil tag],
42 [./cmd_revert.wiki | fossil revert],
43 [./cmd_update.wiki | fossil update],
44 [./cmd_push.wiki | fossil push],
45 [./cmd_pull.wiki | fossil pull],
46 [./
--- www/cmd_new.wiki
+++ www/cmd_new.wiki
@@ -24,9 +24,10 @@
2424
all of the directory's file-system descendants recursively.)
2525
2626
But you can't do all that until you create a repository file with
2727
<code>new</code>.
2828
29
-See also: [./cmd_open.wiki | fossil open],
29
+See also:
30
+[./cmd_open.wiki | fossil open],
3031
[./cmd_add.wiki | fossil add],
3132
[./cmd_server.wiki | fossil ui],
3233
[./reference.wiki | Reference]
3334
3435
ADDED www/cmd_status.wiki
3536
ADDED www/cmd_sync.wiki
3637
ADDED www/cmd_version.wiki
--- www/cmd_new.wiki
+++ www/cmd_new.wiki
@@ -24,9 +24,10 @@
24 all of the directory's file-system descendants recursively.)
25
26 But you can't do all that until you create a repository file with
27 <code>new</code>.
28
29 See also: [./cmd_open.wiki | fossil open],
 
30 [./cmd_add.wiki | fossil add],
31 [./cmd_server.wiki | fossil ui],
32 [./reference.wiki | Reference]
33
34 DDED www/cmd_status.wiki
35 DDED www/cmd_sync.wiki
36 DDED www/cmd_version.wiki
--- www/cmd_new.wiki
+++ www/cmd_new.wiki
@@ -24,9 +24,10 @@
24 all of the directory's file-system descendants recursively.)
25
26 But you can't do all that until you create a repository file with
27 <code>new</code>.
28
29 See also:
30 [./cmd_open.wiki | fossil open],
31 [./cmd_add.wiki | fossil add],
32 [./cmd_server.wiki | fossil ui],
33 [./reference.wiki | Reference]
34
35 DDED www/cmd_status.wiki
36 DDED www/cmd_sync.wiki
37 DDED www/cmd_version.wiki
--- a/www/cmd_status.wiki
+++ b/www/cmd_status.wiki
@@ -0,0 +1,52 @@
1
+<h2>status</h2>
2
+
3
+The <code>status</code> command is informational, it doesn't do anything to
4
+a checked-out project, but it tells you something about it.
5
+
6
+Running <code>&nbsp;fossil&nbsp;status&nbsp;</code> currently prefixes
7
+the output of the <code>[./cmd_changes.wiki | changes]</code> command
8
+with information about the repository and checkout. The information
9
+is in the form of the [./concepts.wiki#aidex | Artifact ID]s of the
10
+server code, the checkout, and the parent (of, I <em>think</em> the
11
+checkout.)
12
+
13
+This is useful for getting an at-a-glance view of the state of your
14
+project, especially in a situation where you need the artifact IDs.
15
+
16
+Here is what I get when I issue a <code>status</code> on my local
17
+version of the <b>fossil</b> repository as I write this:
18
+
19
+<nowiki><pre>
20
+ $ fossil status
21
+ repository: /home/me/myclone.fossil
22
+ local-root: /home/me/fossil/
23
+ server-code: 99d6c9cf3f262720579db177503812814d712fc7
24
+ checkout: a8c3a7ea9249281e0a1fb55fb31d2ad57844f848
25
+ parent: 21cecd209f7201f17e8a784c0d8f735603d440ae
26
+ EDITED www/cmd_.wiki-template
27
+ EDITED www/cmd_add.wiki
28
+ EDITED www/cmd_all.wiki
29
+ EDITED www/cmd_extra.wiki
30
+ EDITED www/cmd_ls.wiki
31
+ EDITED www/cmd_update.wiki
32
+ EDITED www/index.wiki
33
+ $
34
+</pre></nowiki>
35
+
36
+Once I actually make changes to the repository (say, a
37
+[./cmd_commit.wiki | commit&#8212;most of that will change—all
38
+of those files showing as "EDITED" will be checked in and won't
39
+show up, and the artifact IDs will reflect the new state of the
40
+repository.
41
+
42
+If the only thing you want to see is which files in the checked-out
43
+source tree have changed in some way, use the
44
+[./cmd_changes.wiki | <code>changes</code>] command.
45
+
46
+If what you want is the files in the checked-out source tree which are
47
+<em>not</em> part of the project, use the
48
+[./cmd_extra.wiki | <code>extra</code>] command.
49
+
50
+See also: [./cmd_changes.wiki | fossil changes],
51
+[./cmd_extra.wiki | fossil extra],
52
+[./concepts.wiki | <i
--- a/www/cmd_status.wiki
+++ b/www/cmd_status.wiki
@@ -0,0 +1,52 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
--- a/www/cmd_status.wiki
+++ b/www/cmd_status.wiki
@@ -0,0 +1,52 @@
1 <h2>status</h2>
2
3 The <code>status</code> command is informational, it doesn't do anything to
4 a checked-out project, but it tells you something about it.
5
6 Running <code>&nbsp;fossil&nbsp;status&nbsp;</code> currently prefixes
7 the output of the <code>[./cmd_changes.wiki | changes]</code> command
8 with information about the repository and checkout. The information
9 is in the form of the [./concepts.wiki#aidex | Artifact ID]s of the
10 server code, the checkout, and the parent (of, I <em>think</em> the
11 checkout.)
12
13 This is useful for getting an at-a-glance view of the state of your
14 project, especially in a situation where you need the artifact IDs.
15
16 Here is what I get when I issue a <code>status</code> on my local
17 version of the <b>fossil</b> repository as I write this:
18
19 <nowiki><pre>
20 $ fossil status
21 repository: /home/me/myclone.fossil
22 local-root: /home/me/fossil/
23 server-code: 99d6c9cf3f262720579db177503812814d712fc7
24 checkout: a8c3a7ea9249281e0a1fb55fb31d2ad57844f848
25 parent: 21cecd209f7201f17e8a784c0d8f735603d440ae
26 EDITED www/cmd_.wiki-template
27 EDITED www/cmd_add.wiki
28 EDITED www/cmd_all.wiki
29 EDITED www/cmd_extra.wiki
30 EDITED www/cmd_ls.wiki
31 EDITED www/cmd_update.wiki
32 EDITED www/index.wiki
33 $
34 </pre></nowiki>
35
36 Once I actually make changes to the repository (say, a
37 [./cmd_commit.wiki | commit&#8212;most of that will change—all
38 of those files showing as "EDITED" will be checked in and won't
39 show up, and the artifact IDs will reflect the new state of the
40 repository.
41
42 If the only thing you want to see is which files in the checked-out
43 source tree have changed in some way, use the
44 [./cmd_changes.wiki | <code>changes</code>] command.
45
46 If what you want is the files in the checked-out source tree which are
47 <em>not</em> part of the project, use the
48 [./cmd_extra.wiki | <code>extra</code>] command.
49
50 See also: [./cmd_changes.wiki | fossil changes],
51 [./cmd_extra.wiki | fossil extra],
52 [./concepts.wiki | <i
--- a/www/cmd_sync.wiki
+++ b/www/cmd_sync.wiki
@@ -0,0 +1,22 @@
1
+<h2>sync</h2>
2
+
3
+The <code>sync</code> command [./cmd_pull.wiki | <code>pull</code>]s and
4
+[./cmd_push.wiki | <code>push</code>]es repository changes simultaneously.
5
+
6
+This applies to repositories available via a URL, of course. If your
7
+project is strictly local you can do all of the distributed stuff as
8
+long as you are "serving" the repository via http in some fashion, but
9
+it's probably pointless to do so.
10
+
11
+Assuming you aren't running <b>fossil</b> as a high-powered version of
12
+[http://www.gnu.org/software/rcs | RCS], your use of <code>sync</code>
13
+in your projects is up to you. <b>fossil</b> defaults to using a
14
+[./cmd_setting.wiki | setting] of <code>autosync</code>
15
+If you have cloned a repository you will automatically sync with the
16
+original if you [./cmd_commit.wiki | commit] changes to your local
17
+version <em>unless</em> you customize your configuration.
18
+
19
+See also: [./cmd_pull.wiki | fossil pull],
20
+[./cmd_push.wiki | fossil push],
21
+[./cmd_setting.wiki | fossil setting],
22
+[./r
--- a/www/cmd_sync.wiki
+++ b/www/cmd_sync.wiki
@@ -0,0 +1,22 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
--- a/www/cmd_sync.wiki
+++ b/www/cmd_sync.wiki
@@ -0,0 +1,22 @@
1 <h2>sync</h2>
2
3 The <code>sync</code> command [./cmd_pull.wiki | <code>pull</code>]s and
4 [./cmd_push.wiki | <code>push</code>]es repository changes simultaneously.
5
6 This applies to repositories available via a URL, of course. If your
7 project is strictly local you can do all of the distributed stuff as
8 long as you are "serving" the repository via http in some fashion, but
9 it's probably pointless to do so.
10
11 Assuming you aren't running <b>fossil</b> as a high-powered version of
12 [http://www.gnu.org/software/rcs | RCS], your use of <code>sync</code>
13 in your projects is up to you. <b>fossil</b> defaults to using a
14 [./cmd_setting.wiki | setting] of <code>autosync</code>
15 If you have cloned a repository you will automatically sync with the
16 original if you [./cmd_commit.wiki | commit] changes to your local
17 version <em>unless</em> you customize your configuration.
18
19 See also: [./cmd_pull.wiki | fossil pull],
20 [./cmd_push.wiki | fossil push],
21 [./cmd_setting.wiki | fossil setting],
22 [./r
--- a/www/cmd_version.wiki
+++ b/www/cmd_version.wiki
@@ -0,0 +1,12 @@
1
+<h2>version</h2>
2
+
3
+The <code>version</code> command is informational, it doesn't do
4
+anything to a checked-out project, but it tells you something about
5
+it.
6
+
7
+Issuing the version command will print out the short-form of the
8
+artifact ID for the fossil executable.
9
+
10
+See also: [./cmd_status.wiki | fossil status],
11
+[./cmd_info.wiki | fossil info],
12
+[./reference.wiki | Reference]
--- a/www/cmd_version.wiki
+++ b/www/cmd_version.wiki
@@ -0,0 +1,12 @@
 
 
 
 
 
 
 
 
 
 
 
 
--- a/www/cmd_version.wiki
+++ b/www/cmd_version.wiki
@@ -0,0 +1,12 @@
1 <h2>version</h2>
2
3 The <code>version</code> command is informational, it doesn't do
4 anything to a checked-out project, but it tells you something about
5 it.
6
7 Issuing the version command will print out the short-form of the
8 artifact ID for the fossil executable.
9
10 See also: [./cmd_status.wiki | fossil status],
11 [./cmd_info.wiki | fossil info],
12 [./reference.wiki | Reference]
--- www/reference.wiki
+++ www/reference.wiki
@@ -128,11 +128,11 @@
128128
Respositories are automatically added to the set of known repositories
129129
when one of the following commands against the repository: clone, info,
130130
pull, push, or sync
131131
132132
<hr><a href="#tof">&#710;</a>
133
- <a name="cgi">Usage: </a><a href="cmd_cgi">fossil cgi</a> SCRIPT
133
+ <a name="cgi">Usage: </a><a href="cmd_cgi.wiki">fossil cgi</a> SCRIPT
134134
The SCRIPT argument is the name of a file that is the CGI script
135135
that is being run. The command name, "cgi", may be omitted if
136136
the GATEWAY_INTERFACE environment variable is set to "CGI" (which
137137
should always be the case for CGI scripts run by a webserver.) The
138138
SCRIPT file should look something like this:
@@ -143,11 +143,11 @@
143143
The second line defines the name of the repository. After locating
144144
the repository, fossil will generate a webpage on stdout based on
145145
the values of standard CGI environment variables.
146146
147147
<hr><a href="#tof">&#710;</a>
148
- <a name="changes">Usage: </a><a href="cmd_changes">fossil changes</a>
148
+ <a name="changes">Usage: </a><a href="cmd_changes.wiki">fossil changes</a>
149149
Report on the edit status of all files in the current checkout.
150150
See also the "status" and "extra" commands.
151151
152152
<hr><a href="#tof">&#710;</a>
153153
<a name="checkout">Usage: </a><a href="cmd_checkout.wiki">fossil checkout</a> VERSION ?-f|--force?
154154
--- www/reference.wiki
+++ www/reference.wiki
@@ -128,11 +128,11 @@
128 Respositories are automatically added to the set of known repositories
129 when one of the following commands against the repository: clone, info,
130 pull, push, or sync
131
132 <hr><a href="#tof">&#710;</a>
133 <a name="cgi">Usage: </a><a href="cmd_cgi">fossil cgi</a> SCRIPT
134 The SCRIPT argument is the name of a file that is the CGI script
135 that is being run. The command name, "cgi", may be omitted if
136 the GATEWAY_INTERFACE environment variable is set to "CGI" (which
137 should always be the case for CGI scripts run by a webserver.) The
138 SCRIPT file should look something like this:
@@ -143,11 +143,11 @@
143 The second line defines the name of the repository. After locating
144 the repository, fossil will generate a webpage on stdout based on
145 the values of standard CGI environment variables.
146
147 <hr><a href="#tof">&#710;</a>
148 <a name="changes">Usage: </a><a href="cmd_changes">fossil changes</a>
149 Report on the edit status of all files in the current checkout.
150 See also the "status" and "extra" commands.
151
152 <hr><a href="#tof">&#710;</a>
153 <a name="checkout">Usage: </a><a href="cmd_checkout.wiki">fossil checkout</a> VERSION ?-f|--force?
154
--- www/reference.wiki
+++ www/reference.wiki
@@ -128,11 +128,11 @@
128 Respositories are automatically added to the set of known repositories
129 when one of the following commands against the repository: clone, info,
130 pull, push, or sync
131
132 <hr><a href="#tof">&#710;</a>
133 <a name="cgi">Usage: </a><a href="cmd_cgi.wiki">fossil cgi</a> SCRIPT
134 The SCRIPT argument is the name of a file that is the CGI script
135 that is being run. The command name, "cgi", may be omitted if
136 the GATEWAY_INTERFACE environment variable is set to "CGI" (which
137 should always be the case for CGI scripts run by a webserver.) The
138 SCRIPT file should look something like this:
@@ -143,11 +143,11 @@
143 The second line defines the name of the repository. After locating
144 the repository, fossil will generate a webpage on stdout based on
145 the values of standard CGI environment variables.
146
147 <hr><a href="#tof">&#710;</a>
148 <a name="changes">Usage: </a><a href="cmd_changes.wiki">fossil changes</a>
149 Report on the edit status of all files in the current checkout.
150 See also the "status" and "extra" commands.
151
152 <hr><a href="#tof">&#710;</a>
153 <a name="checkout">Usage: </a><a href="cmd_checkout.wiki">fossil checkout</a> VERSION ?-f|--force?
154

Keyboard Shortcuts

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