Fossil SCM

Add warning to the use of fossil -x

jan.nijtmans 2015-06-05 10:25 trunk
Commit 056f41f8509902845f4f03ab7c01be9d6fa6ea95
1 file changed +19 -17
+19 -17
--- www/hints.wiki
+++ www/hints.wiki
@@ -1,49 +1,51 @@
11
<title>Fossil Tips And Usage Hints</title>
22
33
1. Click on nodes of any timeline graph to see diffs between the two
44
selected versions.
55
6
- 2. Add the "--tk" option to "[/help?cmd=diff | fossil diff]" commands
6
+ 2. Add the "--tk" option to "[/help?cmd=diff | fossil diff]" commands
77
to get a pop-up
88
window containing a complete side-by-side diff. (NB: The pop-up
9
- window is run as a separate Tcl/Tk process, so you will need to
9
+ window is run as a separate Tcl/Tk process, so you will need to
1010
have Tcl/Tk installed on your machine for this to work. Visit
1111
[http://www.activestate.com/activetcl] to for a quick download of
1212
Tcl/Tk if you do not already have it on your system.)
1313
14
- 3. The "[/help/clean | fossil clean -f]" or
15
- "[/help/clean | fossil clean --verily]" command is a great
16
- alternative to "make clean".
17
-
18
- 4. Use "[/help?cmd=all | fossil all changes]" to look for any uncommitted
19
- edits in any of your Fossil projects. Use
14
+ 3. The "[/help/clean | fossil clean -x]" command is a great
15
+ alternative to "make clean". You can use "[/help/clean | fossil clean -f]"
16
+ as a slightly safer alternative if the "ignore-glob" setting is
17
+ not set. WARNING: make sure you did a "fossil add" for all source-files
18
+ you plan to commit, otherwise those files will be deleted without warning.
19
+
20
+ 4. Use "[/help?cmd=all | fossil all changes]" to look for any uncommitted
21
+ edits in any of your Fossil projects. Use
2022
"[/help?cmd=all | fossil all pull]" on your laptop
2123
prior to going off network (for example, on a long plane ride)
2224
to make sure you have all the latest content locally. Then run
2325
"[/help/all|fossil all push]" when you get back online to upload
2426
your changes.
25
-
27
+
2628
5. To see an entire timeline, type "all" into the "Max:" entry box.
27
-
29
+
2830
6. You can manually add a "c=CHECKIN" query parameter to the timeline
2931
URL to get a snapshot of what was going on about the time of some
3032
check-in. The "CHECKIN" can be
3133
[./checkin_names.wiki | any valid check-in or version name], including
32
- tags, branch names, and dates. For example, to see what was going
34
+ tags, branch names, and dates. For example, to see what was going
3335
on in the Fossil repository on 2008-01-01, visit
3436
[http://www.fossil-scm.org/fossil/timeline?c=2008-01-01].
35
-
37
+
3638
7. Further to the previous two hints, there are lots of query parameters
3739
that you can add to timeline pages. The available query parameters
3840
are tersely documented [/help?cmd=/timeline | here].
39
-
41
+
4042
8. You can run "[/help?cmd=test-diff | fossil test-diff --tk $file1 $file2]"
41
- to get a pop-up window with side-by-side diffs of two files, even if
42
- neither of the two files is part of any Fossil repository. Note that
43
+ to get a pop-up window with side-by-side diffs of two files, even if
44
+ neither of the two files is part of any Fossil repository. Note that
4345
this command is "test-diff", not "diff".
44
-
46
+
4547
9. On web pages showing the content of a file (for example
4648
[http://www.fossil-scm.org/fossil/artifact/c7dd1de9f]) you can manually
4749
add a query parameter of the form "ln=FROM,TO" to the URL that
4850
will cause the range of lines indicated to be highlighted. This
4951
is useful in pointing out a few lines of code using a hyperlink
@@ -50,10 +52,10 @@
5052
in an email or text message. Example:
5153
[http://www.fossil-scm.org/fossil/artifact/c7dd1de9f?ln=28,30].
5254
Adding the "ln" query parameter without any argument simply turns
5355
on line numbers. This feature only works right with files with
5456
a mimetype of text/plain, of course.
55
-
57
+
5658
10. When editing documentation to be checked in as managed files, you can
5759
preview what the documentation will look like by using the special
5860
"ckout" branch name in the "doc" URL while running "fossil ui".
5961
See the [./embeddeddoc.wiki | embedded documentation] for details.
6062
--- www/hints.wiki
+++ www/hints.wiki
@@ -1,49 +1,51 @@
1 <title>Fossil Tips And Usage Hints</title>
2
3 1. Click on nodes of any timeline graph to see diffs between the two
4 selected versions.
5
6 2. Add the "--tk" option to "[/help?cmd=diff | fossil diff]" commands
7 to get a pop-up
8 window containing a complete side-by-side diff. (NB: The pop-up
9 window is run as a separate Tcl/Tk process, so you will need to
10 have Tcl/Tk installed on your machine for this to work. Visit
11 [http://www.activestate.com/activetcl] to for a quick download of
12 Tcl/Tk if you do not already have it on your system.)
13
14 3. The "[/help/clean | fossil clean -f]" or
15 "[/help/clean | fossil clean --verily]" command is a great
16 alternative to "make clean".
17
18 4. Use "[/help?cmd=all | fossil all changes]" to look for any uncommitted
19 edits in any of your Fossil projects. Use
 
 
20 "[/help?cmd=all | fossil all pull]" on your laptop
21 prior to going off network (for example, on a long plane ride)
22 to make sure you have all the latest content locally. Then run
23 "[/help/all|fossil all push]" when you get back online to upload
24 your changes.
25
26 5. To see an entire timeline, type "all" into the "Max:" entry box.
27
28 6. You can manually add a "c=CHECKIN" query parameter to the timeline
29 URL to get a snapshot of what was going on about the time of some
30 check-in. The "CHECKIN" can be
31 [./checkin_names.wiki | any valid check-in or version name], including
32 tags, branch names, and dates. For example, to see what was going
33 on in the Fossil repository on 2008-01-01, visit
34 [http://www.fossil-scm.org/fossil/timeline?c=2008-01-01].
35
36 7. Further to the previous two hints, there are lots of query parameters
37 that you can add to timeline pages. The available query parameters
38 are tersely documented [/help?cmd=/timeline | here].
39
40 8. You can run "[/help?cmd=test-diff | fossil test-diff --tk $file1 $file2]"
41 to get a pop-up window with side-by-side diffs of two files, even if
42 neither of the two files is part of any Fossil repository. Note that
43 this command is "test-diff", not "diff".
44
45 9. On web pages showing the content of a file (for example
46 [http://www.fossil-scm.org/fossil/artifact/c7dd1de9f]) you can manually
47 add a query parameter of the form "ln=FROM,TO" to the URL that
48 will cause the range of lines indicated to be highlighted. This
49 is useful in pointing out a few lines of code using a hyperlink
@@ -50,10 +52,10 @@
50 in an email or text message. Example:
51 [http://www.fossil-scm.org/fossil/artifact/c7dd1de9f?ln=28,30].
52 Adding the "ln" query parameter without any argument simply turns
53 on line numbers. This feature only works right with files with
54 a mimetype of text/plain, of course.
55
56 10. When editing documentation to be checked in as managed files, you can
57 preview what the documentation will look like by using the special
58 "ckout" branch name in the "doc" URL while running "fossil ui".
59 See the [./embeddeddoc.wiki | embedded documentation] for details.
60
--- www/hints.wiki
+++ www/hints.wiki
@@ -1,49 +1,51 @@
1 <title>Fossil Tips And Usage Hints</title>
2
3 1. Click on nodes of any timeline graph to see diffs between the two
4 selected versions.
5
6 2. Add the "--tk" option to "[/help?cmd=diff | fossil diff]" commands
7 to get a pop-up
8 window containing a complete side-by-side diff. (NB: The pop-up
9 window is run as a separate Tcl/Tk process, so you will need to
10 have Tcl/Tk installed on your machine for this to work. Visit
11 [http://www.activestate.com/activetcl] to for a quick download of
12 Tcl/Tk if you do not already have it on your system.)
13
14 3. The "[/help/clean | fossil clean -x]" command is a great
15 alternative to "make clean". You can use "[/help/clean | fossil clean -f]"
16 as a slightly safer alternative if the "ignore-glob" setting is
17 not set. WARNING: make sure you did a "fossil add" for all source-files
18 you plan to commit, otherwise those files will be deleted without warning.
19
20 4. Use "[/help?cmd=all | fossil all changes]" to look for any uncommitted
21 edits in any of your Fossil projects. Use
22 "[/help?cmd=all | fossil all pull]" on your laptop
23 prior to going off network (for example, on a long plane ride)
24 to make sure you have all the latest content locally. Then run
25 "[/help/all|fossil all push]" when you get back online to upload
26 your changes.
27
28 5. To see an entire timeline, type "all" into the "Max:" entry box.
29
30 6. You can manually add a "c=CHECKIN" query parameter to the timeline
31 URL to get a snapshot of what was going on about the time of some
32 check-in. The "CHECKIN" can be
33 [./checkin_names.wiki | any valid check-in or version name], including
34 tags, branch names, and dates. For example, to see what was going
35 on in the Fossil repository on 2008-01-01, visit
36 [http://www.fossil-scm.org/fossil/timeline?c=2008-01-01].
37
38 7. Further to the previous two hints, there are lots of query parameters
39 that you can add to timeline pages. The available query parameters
40 are tersely documented [/help?cmd=/timeline | here].
41
42 8. You can run "[/help?cmd=test-diff | fossil test-diff --tk $file1 $file2]"
43 to get a pop-up window with side-by-side diffs of two files, even if
44 neither of the two files is part of any Fossil repository. Note that
45 this command is "test-diff", not "diff".
46
47 9. On web pages showing the content of a file (for example
48 [http://www.fossil-scm.org/fossil/artifact/c7dd1de9f]) you can manually
49 add a query parameter of the form "ln=FROM,TO" to the URL that
50 will cause the range of lines indicated to be highlighted. This
51 is useful in pointing out a few lines of code using a hyperlink
@@ -50,10 +52,10 @@
52 in an email or text message. Example:
53 [http://www.fossil-scm.org/fossil/artifact/c7dd1de9f?ln=28,30].
54 Adding the "ln" query parameter without any argument simply turns
55 on line numbers. This feature only works right with files with
56 a mimetype of text/plain, of course.
57
58 10. When editing documentation to be checked in as managed files, you can
59 preview what the documentation will look like by using the special
60 "ckout" branch name in the "doc" URL while running "fossil ui".
61 See the [./embeddeddoc.wiki | embedded documentation] for details.
62

Keyboard Shortcuts

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