send-email: Remove superfluous `my $editor = ...'
[gitweb.git] / Documentation / everyday.txt
index 2105a3d2e7337105263c8a9fef466609c63fc163..9310b650d3ca6b6cb7d69814eb9b800e8c2c85cd 100644 (file)
@@ -25,16 +25,12 @@ Basic Repository[[Basic Repository]]
 
 Everybody uses these commands to maintain git repositories.
 
-  * gitlink:git-init-db[1] or gitlink:git-clone[1] to create a
+  * linkgit:git-init[1] or linkgit:git-clone[1] to create a
     new repository.
 
-  * gitlink:git-fsck-objects[1] to check the repository for errors.
+  * linkgit:git-fsck[1] to check the repository for errors.
 
-  * gitlink:git-prune[1] to remove unused objects in the repository.
-
-  * gitlink:git-repack[1] to pack loose objects for efficiency.
-
-  * gitlink:git-gc[1] to do common housekeeping tasks such as
+  * linkgit:git-gc[1] to do common housekeeping tasks such as
     repack and prune.
 
 Examples
@@ -43,26 +39,21 @@ Examples
 Check health and remove cruft.::
 +
 ------------
-$ git fsck-objects <1>
+$ git fsck <1>
 $ git count-objects <2>
-$ git repack <3>
-$ git gc <4>
+$ git gc <3>
 ------------
 +
 <1> running without `\--full` is usually cheap and assures the
 repository health reasonably well.
 <2> check how many loose objects there are and how much
 disk space is wasted by not repacking.
-<3> without `-a` repacks incrementally.  repacking every 4-5MB
-of loose objects accumulation may be a good rule of thumb.
-<4> it is easier to use `git gc` than individual housekeeping commands
-such as `prune` and `repack`.  This runs `repack -a -d`.
+<3> repacks the local repository and performs other housekeeping tasks.
 
 Repack a small project into single pack.::
 +
 ------------
-$ git repack -a -d <1>
-$ git prune
+$ git gc <1>
 ------------
 +
 <1> pack all the objects reachable from the refs into one pack,
@@ -76,28 +67,28 @@ A standalone individual developer does not exchange patches with
 other people, and works alone in a single repository, using the
 following commands.
 
-  * gitlink:git-show-branch[1] to see where you are.
+  * linkgit:git-show-branch[1] to see where you are.
 
-  * gitlink:git-log[1] to see what happened.
+  * linkgit:git-log[1] to see what happened.
 
-  * gitlink:git-checkout[1] and gitlink:git-branch[1] to switch
+  * linkgit:git-checkout[1] and linkgit:git-branch[1] to switch
     branches.
 
-  * gitlink:git-add[1] to manage the index file.
+  * linkgit:git-add[1] to manage the index file.
 
-  * gitlink:git-diff[1] and gitlink:git-status[1] to see what
+  * linkgit:git-diff[1] and linkgit:git-status[1] to see what
     you are in the middle of doing.
 
-  * gitlink:git-commit[1] to advance the current branch.
+  * linkgit:git-commit[1] to advance the current branch.
 
-  * gitlink:git-reset[1] and gitlink:git-checkout[1] (with
+  * linkgit:git-reset[1] and linkgit:git-checkout[1] (with
     pathname parameters) to undo changes.
 
-  * gitlink:git-merge[1] to merge between local branches.
+  * linkgit:git-merge[1] to merge between local branches.
 
-  * gitlink:git-rebase[1] to maintain topic branches.
+  * linkgit:git-rebase[1] to maintain topic branches.
 
-  * gitlink:git-tag[1] to mark known point.
+  * linkgit:git-tag[1] to mark known point.
 
 Examples
 ~~~~~~~~
@@ -107,9 +98,9 @@ Use a tarball as a starting point for a new repository.::
 ------------
 $ tar zxf frotz.tar.gz
 $ cd frotz
-$ git-init-db
+$ git init
 $ git add . <1>
-$ git commit -m 'import of frotz source tree.'
+$ git commit -m "import of frotz source tree."
 $ git tag v2.43 <2>
 ------------
 +
@@ -148,8 +139,7 @@ modification will be caught if you do `git commit -a` later.
 <8> redo the commit undone in the previous step, using the message
 you originally wrote.
 <9> switch to the master branch.
-<10> merge a topic branch into your master branch.  You can also use
-`git pull . alsa-audio`, i.e. pull from the local repository.
+<10> merge a topic branch into your master branch.
 <11> review commit logs; other forms to limit output can be
 combined and include `\--max-count=10` (show 10 commits),
 `\--until=2005-12-10`, etc.
@@ -164,16 +154,16 @@ A developer working as a participant in a group project needs to
 learn how to communicate with others, and uses these commands in
 addition to the ones needed by a standalone developer.
 
-  * gitlink:git-clone[1] from the upstream to prime your local
+  * linkgit:git-clone[1] from the upstream to prime your local
     repository.
 
-  * gitlink:git-pull[1] and gitlink:git-fetch[1] from "origin"
+  * linkgit:git-pull[1] and linkgit:git-fetch[1] from "origin"
     to keep up-to-date with the upstream.
 
-  * gitlink:git-push[1] to shared repository, if you adopt CVS
+  * linkgit:git-push[1] to shared repository, if you adopt CVS
     style shared repository workflow.
 
-  * gitlink:git-format-patch[1] to prepare e-mail submission, if
+  * linkgit:git-format-patch[1] to prepare e-mail submission, if
     you adopt Linux kernel-style public forum workflow.
 
 Examples
@@ -190,7 +180,7 @@ $ git pull <3>
 $ git log -p ORIG_HEAD.. arch/i386 include/asm-i386 <4>
 $ git pull git://git.kernel.org/pub/.../jgarzik/libata-dev.git ALL <5>
 $ git reset --hard ORIG_HEAD <6>
-$ git prune <7>
+$ git gc <7>
 $ git fetch --tags <8>
 ------------
 +
@@ -213,12 +203,12 @@ Push into another repository.::
 ------------
 satellite$ git clone mothership:frotz frotz <1>
 satellite$ cd frotz
-satellite$ git repo-config --get-regexp '^(remote|branch)\.' <2>
+satellite$ git config --get-regexp '^(remote|branch)\.' <2>
 remote.origin.url mothership:frotz
 remote.origin.fetch refs/heads/*:refs/remotes/origin/*
 branch.master.remote origin
 branch.master.merge refs/heads/master
-satellite$ git repo-config remote.origin.push \
+satellite$ git config remote.origin.push \
            master:refs/remotes/satellite/master <3>
 satellite$ edit/compile/test/commit
 satellite$ git push origin <4>
@@ -266,17 +256,17 @@ project receives changes made by others, reviews and integrates
 them and publishes the result for others to use, using these
 commands in addition to the ones needed by participants.
 
-  * gitlink:git-am[1] to apply patches e-mailed in from your
+  * linkgit:git-am[1] to apply patches e-mailed in from your
     contributors.
 
-  * gitlink:git-pull[1] to merge from your trusted lieutenants.
+  * linkgit:git-pull[1] to merge from your trusted lieutenants.
 
-  * gitlink:git-format-patch[1] to prepare and send suggested
+  * linkgit:git-format-patch[1] to prepare and send suggested
     alternative to contributors.
 
-  * gitlink:git-revert[1] to undo botched commits.
+  * linkgit:git-revert[1] to undo botched commits.
 
-  * gitlink:git-push[1] to publish the bleeding edge.
+  * linkgit:git-push[1] to publish the bleeding edge.
 
 
 Examples
@@ -301,7 +291,7 @@ $ git merge topic/one topic/two && git merge hold/linus <8>
 $ git checkout maint
 $ git cherry-pick master~4 <9>
 $ compile/test
-$ git tag -s -m 'GIT 0.99.9x' v0.99.9x <10>
+$ git tag -s -m "GIT 0.99.9x" v0.99.9x <10>
 $ git fetch ko && git show-branch master maint 'tags/ko-*' <11>
 $ git push ko <12>
 $ git push ko v0.99.9x <13>
@@ -351,10 +341,10 @@ Repository Administration[[Repository Administration]]
 A repository administrator uses the following tools to set up
 and maintain access to the repository by developers.
 
-  * gitlink:git-daemon[1] to allow anonymous download from
+  * linkgit:git-daemon[1] to allow anonymous download from
     repository.
 
-  * gitlink:git-shell[1] can be used as a 'restricted login shell'
+  * linkgit:git-shell[1] can be used as a 'restricted login shell'
     for shared central repository users.
 
 link:howto/update-hook-example.txt[update hook howto] has a good