everyday: update for v1.5.0
Fix minor mark-up mistakes and adjust to v1.5.0 BCP, namely: - use "git add" instead of "git update-index"; - use "git merge" instead of "git pull ."; - use separate remote layout; - use config instead of remotes/origin file; Also updates "My typical git day" example since now I have 'next' branch these days. Signed-off-by: Junio C Hamano <junkio@cox.net>
Junio C Hamano committed
Dec 26, 2006 at 22:42 UTC
268b827d9883e77f395a63e4afa10ebbac10bfcf
1 file changed
+48
-41
Documentation/everyday.txt
+48
-41
@@ -47,11 +47,11 @@ $ git repack <3>
47
$ git prune <4>
48
------------
49
+
50
-<1> running without "--full" is usually cheap and assures the
50
+<1> running without `\--full` is usually cheap and assures the
51
repository health reasonably well.
52
<2> check how many loose objects there are and how much
53
disk space is wasted by not repacking.
54
-<3> without "-a" repacks incrementally. repacking every 4-5MB
54
+<3> without `-a` repacks incrementally. repacking every 4-5MB
55
of loose objects accumulation may be a good rule of thumb.
56
<4> after repack, prune removes the duplicate loose objects.
57
@@ -80,8 +80,7 @@ following commands.
80
* gitlink:git-checkout[1] and gitlink:git-branch[1] to switch
81
branches.
82
83
- * gitlink:git-add[1] and gitlink:git-update-index[1] to manage
84
- the index file.
83
+ * gitlink:git-add[1] to manage the index file.
84
85
* gitlink:git-diff[1] and gitlink:git-status[1] to see what
86
you are in the middle of doing.
@@ -91,8 +90,7 @@ following commands.
90
* gitlink:git-reset[1] and gitlink:git-checkout[1] (with
91
pathname parameters) to undo changes.
92
94
- * gitlink:git-pull[1] with "." as the remote to merge between
95
- local branches.
93
+ * gitlink:git-merge[1] to merge between local branches.
94
95
* gitlink:git-rebase[1] to maintain topic branches.
96
@@ -101,7 +99,7 @@ following commands.
99
Examples
100
~~~~~~~~
101
104
-Use a tarball as a starting point for a new repository:
102
+Use a tarball as a starting point for a new repository.::
103
+
104
------------
105
$ tar zxf frotz.tar.gz
@@ -123,7 +121,7 @@ $ edit/compile/test
121
$ git checkout -- curses/ux_audio_oss.c <2>
122
$ git add curses/ux_audio_alsa.c <3>
123
$ edit/compile/test
126
-$ git diff <4>
124
+$ git diff HEAD <4>
125
$ git commit -a -s <5>
126
$ edit/compile/test
127
$ git reset --soft HEAD^ <6>
@@ -131,15 +129,15 @@ $ edit/compile/test
129
$ git diff ORIG_HEAD <7>
130
$ git commit -a -c ORIG_HEAD <8>
131
$ git checkout master <9>
134
-$ git pull . alsa-audio <10>
132
+$ git merge alsa-audio <10>
133
$ git log --since='3 days ago' <11>
134
$ git log v2.43.. curses/ <12>
135
------------
136
+
137
<1> create a new topic branch.
140
-<2> revert your botched changes in "curses/ux_audio_oss.c".
138
+<2> revert your botched changes in `curses/ux_audio_oss.c`.
139
<3> you need to tell git if you added a new file; removal and
142
-modification will be caught if you do "commit -a" later.
140
+modification will be caught if you do `git commit -a` later.
141
<4> to see what changes you are committing.
142
<5> commit everything as you have tested, with your sign-off.
143
<6> take the last commit back, keeping what is in the working tree.
@@ -147,11 +145,13 @@ modification will be caught if you do "commit -a" later.
145
<8> redo the commit undone in the previous step, using the message
146
you originally wrote.
147
<9> switch to the master branch.
150
-<10> merge a topic branch into your master branch
148
+<10> merge a topic branch into your master branch. You can also use
149
+`git pull . alsa-audio`, i.e. pull from the local repository.
150
<11> review commit logs; other forms to limit output can be
152
-combined and include --max-count=10 (show 10 commits), --until='2005-12-10'.
153
-<12> view only the changes that touch what's in curses/
154
-directory, since v2.43 tag.
151
+combined and include `\--max-count=10` (show 10 commits),
152
+`\--until=2005-12-10`, etc.
153
+<12> view only the changes that touch what's in `curses/`
154
+directory, since `v2.43` tag.
155
156
157
Individual Developer (Participant)[[Individual Developer (Participant)]]
@@ -193,7 +193,7 @@ $ git fetch --tags <8>
193
+
194
<1> repeat as needed.
195
<2> extract patches from your branch for e-mail submission.
196
-<3> "pull" fetches from "origin" by default and merges into the
196
+<3> `git pull` fetches from `origin` by default and merges into the
197
current branch.
198
<4> immediately after pulling, look at the changes done upstream
199
since last time we checked, only in the
@@ -201,37 +201,41 @@ area we are interested in.
201
<5> fetch from a specific branch from a specific repository and merge.
202
<6> revert the pull.
203
<7> garbage collect leftover objects from reverted pull.
204
-<8> from time to time, obtain official tags from the "origin"
205
-and store them under .git/refs/tags/.
204
+<8> from time to time, obtain official tags from the `origin`
205
+and store them under `.git/refs/tags/`.
206
207
208
Push into another repository.::
209
+
210
------------
211
-satellite$ git clone mothership:frotz/.git frotz <1>
211
+satellite$ git clone mothership:frotz frotz <1>
212
satellite$ cd frotz
213
-satellite$ cat .git/remotes/origin <2>
214
-URL: mothership:frotz/.git
215
-Pull: master:origin
216
-satellite$ echo 'Push: master:satellite' >>.git/remotes/origin <3>
213
+satellite$ git repo-config --get-regexp '^(remote|branch)\.' <2>
214
+remote.origin.url mothership:frotz
215
+remote.origin.fetch refs/heads/*:refs/remotes/origin/*
216
+branch.master.remote origin
217
+branch.master.merge refs/heads/master
218
+satellite$ git repo-config remote.origin.push \
219
+ master:refs/remotes/satellite/master <3>
220
satellite$ edit/compile/test/commit
221
satellite$ git push origin <4>
222
223
mothership$ cd frotz
224
mothership$ git checkout master
222
-mothership$ git pull . satellite <5>
225
+mothership$ git merge satellite/master <5>
226
------------
227
+
228
<1> mothership machine has a frotz repository under your home
229
directory; clone from it to start a repository on the satellite
230
machine.
228
-<2> clone creates this file by default. It arranges "git pull"
229
-to fetch and store the master branch head of mothership machine
230
-to local "origin" branch.
231
-<3> arrange "git push" to push local "master" branch to
232
-"satellite" branch of the mothership machine.
233
-<4> push will stash our work away on "satellite" branch on the
234
-mothership machine. You could use this as a back-up method.
231
+<2> clone sets these configuration variables by default.
232
+It arranges `git pull` to fetch and store the branches of mothership
233
+machine to local `remotes/origin/*` tracking branches.
234
+<3> arrange `git push` to push local `master` branch to
235
+`remotes/satellite/master` branch of the mothership machine.
236
+<4> push will stash our work away on `remotes/satellite/master`
237
+tracking branch on the mothership machine. You could use this as
238
+a back-up method.
239
<5> on mothership machine, merge the work done on the satellite
240
machine into the master branch.
241
@@ -247,7 +251,7 @@ $ git format-patch -k -m --stdout v2.6.14..private2.6.14 |
251
+
252
<1> create a private branch based on a well known (but somewhat behind)
253
tag.
250
-<2> forward port all changes in private2.6.14 branch to master branch
254
+<2> forward port all changes in `private2.6.14` branch to `master` branch
255
without a formal "merging".
256
257
@@ -284,13 +288,13 @@ $ mailx <3>
288
& s 2 3 4 5 ./+to-apply
289
& s 7 8 ./+hold-linus
290
& q
287
-$ git checkout master
291
+$ git checkout -b topic/one master
292
$ git am -3 -i -s -u ./+to-apply <4>
293
$ compile/test
294
$ git checkout -b hold/linus && git am -3 -i -s -u ./+hold-linus <5>
295
$ git checkout topic/one && git rebase master <6>
292
-$ git checkout pu && git reset --hard master <7>
293
-$ git pull . topic/one topic/two && git pull . hold/linus <8>
296
+$ git checkout pu && git reset --hard next <7>
297
+$ git merge topic/one topic/two && git merge hold/linus <8>
298
$ git checkout maint
299
$ git cherry-pick master~4 <9>
300
$ compile/test
@@ -307,29 +311,32 @@ they are.
311
that are not quite ready.
312
<4> apply them, interactively, with my sign-offs.
313
<5> create topic branch as needed and apply, again with my
310
-sign-offs.
314
+sign-offs.
315
<6> rebase internal topic branch that has not been merged to the
316
master, nor exposed as a part of a stable branch.
313
-<7> restart "pu" every time from the master.
317
+<7> restart `pu` every time from the next.
318
<8> and bundle topic branches still cooking.
319
<9> backport a critical fix.
320
<10> create a signed tag.
321
<11> make sure I did not accidentally rewind master beyond what I
318
-already pushed out. "ko" shorthand points at the repository I have
322
+already pushed out. `ko` shorthand points at the repository I have
323
at kernel.org, and looks like this:
324
+
325
------------
326
$ cat .git/remotes/ko
327
URL: kernel.org:/pub/scm/git/git.git
328
Pull: master:refs/tags/ko-master
329
+Pull: next:refs/tags/ko-next
330
Pull: maint:refs/tags/ko-maint
331
Push: master
332
+Push: next
333
Push: +pu
334
Push: maint
335
------------
336
+
331
-In the output from "git show-branch", "master" should have
332
-everything "ko-master" has.
337
+In the output from `git show-branch`, `master` should have
338
+everything `ko-master` has, and `next` should have
339
+everything `ko-next` has.
340
341
<12> push out the bleeding edge.
342
<13> push the tag out, too.
@@ -406,7 +413,7 @@ $ grep git /etc/shells <2>
413
------------
414
+
415
<1> log-in shell is set to /usr/bin/git-shell, which does not
409
-allow anything but "git push" and "git pull". The users should
416
+allow anything but `git push` and `git pull`. The users should
417
get an ssh access to the machine.
418
<2> in many distributions /etc/shells needs to list what is used
419
as the login shell.