|
fda5b81…
|
drh
|
1 |
<title>Fossil Tips And Usage Hints</title> |
|
fda5b81…
|
drh
|
2 |
|
|
50a8a1b…
|
drh
|
3 |
A collection of useful hints and tricks in no particular order: |
|
50a8a1b…
|
drh
|
4 |
|
|
50a8a1b…
|
drh
|
5 |
1. Click on two nodes of any timeline graph in succession |
|
50a8a1b…
|
drh
|
6 |
to see a diff between the two versions. |
|
fda5b81…
|
drh
|
7 |
|
|
c64f28d…
|
drh
|
8 |
2. Add the "--tk" option to "[/help/diff | fossil diff]" commands |
|
fda5b81…
|
drh
|
9 |
to get a pop-up |
|
fda5b81…
|
drh
|
10 |
window containing a complete side-by-side diff. (NB: The pop-up |
|
056f41f…
|
jan.nijtmans
|
11 |
window is run as a separate Tcl/Tk process, so you will need to |
|
fda5b81…
|
drh
|
12 |
have Tcl/Tk installed on your machine for this to work. Visit |
|
285430a…
|
drh
|
13 |
[http://www.activestate.com/activetcl] for a quick download of |
|
fda5b81…
|
drh
|
14 |
Tcl/Tk if you do not already have it on your system.) |
|
fda5b81…
|
drh
|
15 |
|
|
056f41f…
|
jan.nijtmans
|
16 |
3. The "[/help/clean | fossil clean -x]" command is a great |
|
056f41f…
|
jan.nijtmans
|
17 |
alternative to "make clean". You can use "[/help/clean | fossil clean -f]" |
|
056f41f…
|
jan.nijtmans
|
18 |
as a slightly safer alternative if the "ignore-glob" setting is |
|
056f41f…
|
jan.nijtmans
|
19 |
not set. WARNING: make sure you did a "fossil add" for all source-files |
|
056f41f…
|
jan.nijtmans
|
20 |
you plan to commit, otherwise those files will be deleted without warning. |
|
056f41f…
|
jan.nijtmans
|
21 |
|
|
c64f28d…
|
drh
|
22 |
4. Use "[/help/all | fossil all changes]" to look for any uncommitted |
|
056f41f…
|
jan.nijtmans
|
23 |
edits in any of your Fossil projects. Use |
|
c64f28d…
|
drh
|
24 |
"[/help/all | fossil all pull]" on your laptop |
|
fda5b81…
|
drh
|
25 |
prior to going off network (for example, on a long plane ride) |
|
e94bef2…
|
drh
|
26 |
to make sure you have all the latest content locally. Then run |
|
e94bef2…
|
drh
|
27 |
"[/help/all|fossil all push]" when you get back online to upload |
|
e94bef2…
|
drh
|
28 |
your changes. |
|
056f41f…
|
jan.nijtmans
|
29 |
|
|
d5ef91f…
|
drh
|
30 |
5. To see an entire timeline, type "all" into the "Max:" entry box. |
|
056f41f…
|
jan.nijtmans
|
31 |
|
|
fda5b81…
|
drh
|
32 |
6. You can manually add a "c=CHECKIN" query parameter to the timeline |
|
fda5b81…
|
drh
|
33 |
URL to get a snapshot of what was going on about the time of some |
|
fe38a76…
|
drh
|
34 |
check-in. The "CHECKIN" can be |
|
fda5b81…
|
drh
|
35 |
[./checkin_names.wiki | any valid check-in or version name], including |
|
056f41f…
|
jan.nijtmans
|
36 |
tags, branch names, and dates. For example, to see what was going |
|
fda5b81…
|
drh
|
37 |
on in the Fossil repository on 2008-01-01, visit |
|
143f1db…
|
wyoung
|
38 |
[/timeline?c=2008-01-01]. |
|
056f41f…
|
jan.nijtmans
|
39 |
|
|
fda5b81…
|
drh
|
40 |
7. Further to the previous two hints, there are lots of query parameters |
|
fda5b81…
|
drh
|
41 |
that you can add to timeline pages. The available query parameters |
|
c64f28d…
|
drh
|
42 |
are tersely documented [/help/www/timeline | here]. |
|
056f41f…
|
jan.nijtmans
|
43 |
|
|
c64f28d…
|
drh
|
44 |
8. You can run "[/help/xdiff | fossil xdiff --tk $file1 $file2]" |
|
8ed9fdd…
|
drh
|
45 |
to get a Tk pop-up window with side-by-side diffs of two files, even if |
|
056f41f…
|
jan.nijtmans
|
46 |
neither of the two files is part of any Fossil repository. Note that |
|
8ed9fdd…
|
drh
|
47 |
this command is "xdiff", not "diff". Change <nobr>--tk</nobr> to |
|
8ed9fdd…
|
drh
|
48 |
<nobr>--by</nobr> to see the diff in your web browser. |
|
056f41f…
|
jan.nijtmans
|
49 |
|
|
fda5b81…
|
drh
|
50 |
9. On web pages showing the content of a file (for example |
|
143f1db…
|
wyoung
|
51 |
[/artifact/c7dd1de9f]) you can manually |
|
fda5b81…
|
drh
|
52 |
add a query parameter of the form "ln=FROM,TO" to the URL that |
|
fda5b81…
|
drh
|
53 |
will cause the range of lines indicated to be highlighted. This |
|
fda5b81…
|
drh
|
54 |
is useful in pointing out a few lines of code using a hyperlink |
|
c49030f…
|
drh
|
55 |
in an email or text message. Example: |
|
143f1db…
|
wyoung
|
56 |
[/artifact/c7dd1de9f?ln=28,30]. |
|
fda5b81…
|
drh
|
57 |
Adding the "ln" query parameter without any argument simply turns |
|
fda5b81…
|
drh
|
58 |
on line numbers. This feature only works right with files with |
|
fda5b81…
|
drh
|
59 |
a mimetype of text/plain, of course. |
|
056f41f…
|
jan.nijtmans
|
60 |
|
|
fda5b81…
|
drh
|
61 |
10. When editing documentation to be checked in as managed files, you can |
|
fda5b81…
|
drh
|
62 |
preview what the documentation will look like by using the special |
|
fda5b81…
|
drh
|
63 |
"ckout" branch name in the "doc" URL while running "fossil ui". |
|
fda5b81…
|
drh
|
64 |
See the [./embeddeddoc.wiki | embedded documentation] for details. |
|
50a8a1b…
|
drh
|
65 |
|
|
c64f28d…
|
drh
|
66 |
11. Use the "[/help/ui|fossil ui /]" command to bring up a menu of |
|
50a8a1b…
|
drh
|
67 |
all of your local Fossil repositories in your web browser. |
|
50a8a1b…
|
drh
|
68 |
|
|
50a8a1b…
|
drh
|
69 |
12. If you have a bunch of Fossil repositories living on a remote machine |
|
50a8a1b…
|
drh
|
70 |
that you are able to access using ssh using a command like |
|
50a8a1b…
|
drh
|
71 |
"ssh login@remote", then you can bring up a user interface for all |
|
50a8a1b…
|
drh
|
72 |
those remote repositories using the command: |
|
c64f28d…
|
drh
|
73 |
"[/help/ui|fossil ui login@remote:/]". This works by tunneling |
|
50a8a1b…
|
drh
|
74 |
all HTTP traffic through SSH to the remote machine. |