@matheusbsbs / matheus-bagliano / commits / 119550af0c
Fork 0

Documentation: updates to "Everyday GIT"

Remove the introduction: I think it should be obvious why we have this. (And if it isn't obvious then we've got other problems.) Replace reference to git whatchanged by git log. Miscellaneous style and grammar fixes. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>

J. Bruce Fields committed Oct 25, 2006 at 22:43 UTC 119550af0c9f3cdd920e8d0e04b68b40b8485fdc
1 file changed +12 -31
Documentation/everyday.txt
+12 -31
@@ -1,22 +1,7 @@
1 Everyday GIT With 20 Commands Or So
2 ===================================
3
4 -GIT suite has over 100 commands, and the manual page for each of
5 -them discusses what the command does and how it is used in
6 -detail, but until you know what command should be used in order
7 -to achieve what you want to do, you cannot tell which manual
8 -page to look at, and if you know that already you do not need
9 -the manual.
10 -
11 -Does that mean you need to know all of them before you can use
12 -git? Not at all. Depending on the role you play, the set of
13 -commands you need to know is slightly different, but in any case
14 -what you need to learn is far smaller than the full set of
15 -commands to carry out your day-to-day work. This document is to
16 -serve as a cheat-sheet and a set of pointers for people playing
17 -various roles.
18 -
19 -<<Basic Repository>> commands are needed by people who has a
4 +<<Basic Repository>> commands are needed by people who have a
5 repository --- that is everybody, because every working tree of
6 git is a repository.
7
@@ -25,28 +10,27 @@ essential for anybody who makes a commit, even for somebody who
10 works alone.
11
12 If you work with other people, you will need commands listed in
28 -<<Individual Developer (Participant)>> section as well.
13 +the <<Individual Developer (Participant)>> section as well.
14
30 -People who play <<Integrator>> role need to learn some more
15 +People who play the <<Integrator>> role need to learn some more
16 commands in addition to the above.
17
18 <<Repository Administration>> commands are for system
34 -administrators who are responsible to care and feed git
35 -repositories to support developers.
19 +administrators who are responsible for the care and feeding
20 +of git repositories.
21
22
23 Basic Repository[[Basic Repository]]
24 ------------------------------------
25
41 -Everybody uses these commands to feed and care git repositories.
26 +Everybody uses these commands to maintain git repositories.
27
28 * gitlink:git-init-db[1] or gitlink:git-clone[1] to create a
29 new repository.
30
46 - * gitlink:git-fsck-objects[1] to validate the repository.
31 + * gitlink:git-fsck-objects[1] to check the repository for errors.
32
48 - * gitlink:git-prune[1] to garbage collect cruft in the
49 - repository.
33 + * gitlink:git-prune[1] to remove unused objects in the repository.
34
35 * gitlink:git-repack[1] to pack loose objects for efficiency.
36
@@ -78,8 +62,8 @@ $ git repack -a -d <1>
62 $ git prune
63 ------------
64 +
81 -<1> pack all the objects reachable from the refs into one pack
82 -and remove unneeded other packs
65 +<1> pack all the objects reachable from the refs into one pack,
66 +then remove the other packs.
67
68
69 Individual Developer (Standalone)[[Individual Developer (Standalone)]]
@@ -93,9 +77,6 @@ following commands.
77
78 * gitlink:git-log[1] to see what happened.
79
96 - * gitlink:git-whatchanged[1] to find out where things have
97 - come from.
98 -
80 * gitlink:git-checkout[1] and gitlink:git-branch[1] to switch
81 branches.
82
@@ -120,7 +101,7 @@ following commands.
101 Examples
102 ~~~~~~~~
103
123 -Extract a tarball and create a working tree and a new repository to keep track of it.::
104 +Use a tarball as a starting point for a new repository:
105 +
106 ------------
107 $ tar zxf frotz.tar.gz
@@ -203,7 +184,7 @@ $ cd my2.6
184 $ edit/compile/test; git commit -a -s <1>
185 $ git format-patch origin <2>
186 $ git pull <3>
206 -$ git whatchanged -p ORIG_HEAD.. arch/i386 include/asm-i386 <4>
187 +$ git log -p ORIG_HEAD.. arch/i386 include/asm-i386 <4>
188 $ git pull git://git.kernel.org/pub/.../jgarzik/libata-dev.git ALL <5>
189 $ git reset --hard ORIG_HEAD <6>
190 $ git prune <7>