move to subdir
[ikiwiki.git] / doc / rcs / git / gitmanual.mdwn
1 Main use case I am trying to accomplish: Edit wiki pages offline.
2
3 1. Imagine you're the administrator of the site and you want to checkout the wiki sources to give them some love while on a train journey.
4 2. Or you are writing a complex document and you want to simply use your favourite $EDITOR
5 3. Learn a little more about [git](http://git.or.cz/)
6
7 # Workflow
8
9 ## on webconverger.org/si.dabase.com/hendry
10
11 Wiki page created with [ikiwiki](http://ikiwiki.info). Example usb.mdwn [usb](http://webconverger.org/usb/)
12
13 ## on monty (my laptop)
14
15 I wonder why a "pull" doesn't just init a repo like a "svn co" does?
16 Ah, I should have used `git-clone ssh://si.dabase.com/home/hendry/wikiwc/.git/`
17
18     monty:~/git-testing% git-init
19     Initialized empty Git repository in .git/
20
21 You might want to set some config variables like your email as this [tutorial](http://www.kernel.org/pub/software/scm/git/docs/tutorial.html) describes.
22
23     monty:~/git-testing% git-pull ssh://si.dabase.com/home/hendry/wikiwc/.git/
24     warning: no common commits
25     remote: Generating pack...
26     remote: Done counting 746 objects.
27     remote: Deltifying 746 objects...
28     remote:  100% (746/746) done
29     Indexing 746 objects...
30     remote: Total 746 (delta 443), reused 723 (delta 431)
31      100% (746/746) done
32     Resolving 443 deltas...
33      100% (443/443) done
34
35     echo "blah" >> usb.mdwn
36     monty:~/git-testing% git-commit -a -m "added test"
37     Created commit d3507df: added test
38      1 files changed, 1 insertions(+), 0 deletions(-)
39
40 I should have used `git push origin` here...
41
42     monty:~/git-testing% git-push ssh://si.dabase.com/home/hendry/wikiwc/.git/
43     updating 'refs/heads/master'
44       from 75a4a8e94e5fff2a4beced1574e772742d3f9847
45       to   d3507dfe19b469e61a728d1b0a833a5f480f5802
46     Generating pack...
47     Done counting 5 objects.
48     Result has 3 objects.
49     Deltifying 3 objects...
50      100% (3/3) done
51     Writing 3 objects...
52      100% (3/3) done
53     Total 3 (delta 2), reused 0 (delta 0)
54     refs/heads/master: 75a4a8e94e5fff2a4beced1574e772742d3f9847 -> d3507dfe19b469e61a728d1b0a833a5f480f5802
55
56
57 ## on webconverger.org/si.dabase.com/hendry
58
59     hendry:239$ git-status 
60     # On branch master
61     # Changes to be committed:
62     #   (use "git reset HEAD <file>..." to unstage)
63     #
64     #       modified:   usb.mdwn
65     #
66     # Untracked files:
67     #   (use "git add <file>..." to include in what will be committed)
68     #
69     #       .ikiwiki/
70
71 Great, we see the usb.mdwn file has been modified. Now we need to check it out to update the local work tree (and the wiki?)
72
73     hendry:242$ git-checkout master usb.mdwn
74
75 I find this a little odd... Is this a required step for ikiwiki?
76
77 # Stuff I am confused about
78
79 * this master/origin stuff
80 * why do I have to explicitly say the filename "usb.mdwn" for it to be updated?
81 * how ikiwiki interfaces with git. does it have its own working copy? or is it the files simply in ~/wikiwc?
82 * I know git-push seems unpopular (git-pull seems to have the emphasis), though I think it is really convenient
83
84 # Ack
85
86 Thanks to gitte on #git on Freenode