Git quick reference

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
m (Add the --track option to git checkout)
m (Configure your global git settings: Rephrase the paragraph to make it clearer.)
(17 intermediate revisions by 10 users not shown)
Line 1: Line 1:
 
[[Category:Draft Documentation]]
 
[[Category:Draft Documentation]]
  
{{admon/warning|Quick Reference Only|This is not intended to be an exhaustive list of git operations. See the [http://git.or.cz/#documentation documentation] for that.}}
+
{{admon/warning|Quick Reference Only|This is not intended to be an exhaustive list of git operations. See the [http://git-scm.com/documentation documentation] for that.}}
 
== Basic Operations ==
 
== Basic Operations ==
  
 
=== Configure your global git settings ===
 
=== Configure your global git settings ===
Running these commands will setup your global git settings. You should obviously use your own contact details.  Should you wish to change your details, you can edit the '~/.gitconfig' file for global settings, or edit '.git/config' to change settings on a particular repo.
+
Running these commands will setup your global git settings. You should obviously use your own contact details.
  
<code>git-config --global user.name "John Q. Public"</code>
+
git config --global user.name "John Q. Public"
 +
git config --global user.email "john.public@example.com"
 +
git config --global color.ui auto
  
<code>git-config --global user.email "john.public@example.com"</code>
+
Should you wish to change your details later on, you can manually edit the <code>~/.gitconfig</code> file for global settings, or edit <code>.git/config</code> to change settings on a particular repo. Alternatively, you can simply run the above commands again with new details.
  
<code>git-config --global color.diff auto</code>
+
See the [http://www.kernel.org/pub/software/scm/git/docs/git-config.html <code>git config</code>] documentation for many more configuration options.
  
<code>git-config --global color.status auto</code>
+
==== Display current branch in bash ====
  
<code>git-config --global color.branch auto</code>
+
If you work with branches, and you should, this setting helps you keep track of which branch you are in at a given time.  If you are in a git working directory, it shows the current branch as part of the prompt:
 +
 
 +
<pre>[user@host directory-name (master)]$ </pre>
 +
 
 +
To enable this, you can take advantage of the <code>__git_ps1</code> function, provided by <code>/usr/share/git-core/contrib/completion/git-prompt.sh</code> in the git package. Add those lines to <code>~/.bashrc</code>:
 +
export PS1='[\u@\h \W$(declare -F __git_ps1 &>/dev/null && __git_ps1 " (%s)")]\$ '
 +
 
 +
If you do not have the [https://admin.fedoraproject.org/pkgdb/acls/name/bash-completion bash-completion] package installed, you must manually source the git completion script prior to using <code>__git_ps1()</code>. To do this, add to <code>~/.bashrc</code>, either:
 +
* <code>source /usr/share/git-core/contrib/completion/git-prompt.sh</code> for Fedora 18+
 +
* <code>source /etc/bash_completion.d/git</code> for RedHat/CentOS or Fedora 16-17
 +
 
 +
To activate bash configuration changes, run <code>source ~/.bashrc</code>.
 +
 
 +
In addition to displaying the current branch, this will show when you are in the middle of a merge or rebase.
 +
 
 +
You might also want to display when there are changes in your work tree or the git index:
 +
[user@host directory-name (master*)]$
 +
[user@host directory-name (master+)]$
 +
[user@host directory-name (master%)]$
 +
 
 +
* On the first line, a tracked file was modified
 +
* On the second line, a tracked file was modified and staged (with <code>git add</code>)
 +
* On the third line, you have untracked files in your tree
 +
 
 +
Of course, those can combine themselves...
 +
 
 +
To do so, simply add these lines in your <code>~/.bashrc</code>, right before the line modifying your prompt:
 +
export GIT_PS1_SHOWDIRTYSTATE=true
 +
export GIT_PS1_SHOWUNTRACKEDFILES=true
 +
 
 +
See the comments at the beginning of <code>/etc/bash_completion.d/git</code> for more details.
  
 
=== Initialize a new repo ===
 
=== Initialize a new repo ===
Line 56: Line 88:
 
Use:
 
Use:
  
<code>git branch -a</code>
+
<code>git branch -r</code>
  
to determine the name of the remote branch you want to work on. Remote branches will be preceded by <code>origin/</code>.  Then use this to switch to it:
+
to determine the name of the upstream branch you want to work on. Then use this to switch to it:
  
<code>git checkout --track -b <branch> origin/<branch></code>
+
<code>git checkout --track origin/<branch></code>
 +
 
 +
This creates a local branch named <code><branch></code> and tells git that it came from <code>origin/<branch></code>.  Using <code>git status</code> will show you whether your local branch is ahead, behind, or otherwise different than the upstream branch.
 +
 
 +
If you want to use a different name for your local branch, you can use:
 +
 
 +
<code>git checkout --track --branch <some-other-name> origin/<branch></code>
  
 
== Maintainer Operations ==
 
== Maintainer Operations ==
 +
 +
=== Remove a remote branch ===
 +
{{admon/warning | This is a dangerous operation. | If there's any chance that other people are using the remote branch, you should at least warn them before doing this.}}
 +
{{admon/warning | This doesn't entirely work right now for Fedora pkgs git | This may give a (hook denied) error. See [https://fedorahosted.org/fedora-infrastructure/ticket/3135] for details.}}
 +
Assuming you had a branch named ''blah'' on the remote server, you could remove it by typing:
 +
 +
<code>git push origin :''blah''</code>
  
 
=== Apply mailed git patch ===
 
=== Apply mailed git patch ===
 
<code>git am <file></code>
 
<code>git am <file></code>

Revision as of 05:39, 10 January 2013


Warning (medium size).png
Quick Reference Only
This is not intended to be an exhaustive list of git operations. See the documentation for that.

Contents

Basic Operations

Configure your global git settings

Running these commands will setup your global git settings. You should obviously use your own contact details.

git config --global user.name "John Q. Public"
git config --global user.email "john.public@example.com"
git config --global color.ui auto

Should you wish to change your details later on, you can manually edit the ~/.gitconfig file for global settings, or edit .git/config to change settings on a particular repo. Alternatively, you can simply run the above commands again with new details.

See the git config documentation for many more configuration options.

Display current branch in bash

If you work with branches, and you should, this setting helps you keep track of which branch you are in at a given time. If you are in a git working directory, it shows the current branch as part of the prompt:

[user@host directory-name (master)]$ 

To enable this, you can take advantage of the __git_ps1 function, provided by /usr/share/git-core/contrib/completion/git-prompt.sh in the git package. Add those lines to ~/.bashrc:

export PS1='[\u@\h \W$(declare -F __git_ps1 &>/dev/null && __git_ps1 " (%s)")]\$ '

If you do not have the bash-completion package installed, you must manually source the git completion script prior to using __git_ps1(). To do this, add to ~/.bashrc, either:

  • source /usr/share/git-core/contrib/completion/git-prompt.sh for Fedora 18+
  • source /etc/bash_completion.d/git for RedHat/CentOS or Fedora 16-17

To activate bash configuration changes, run source ~/.bashrc.

In addition to displaying the current branch, this will show when you are in the middle of a merge or rebase.

You might also want to display when there are changes in your work tree or the git index:

[user@host directory-name (master*)]$ 
[user@host directory-name (master+)]$ 
[user@host directory-name (master%)]$
  • On the first line, a tracked file was modified
  • On the second line, a tracked file was modified and staged (with git add)
  • On the third line, you have untracked files in your tree

Of course, those can combine themselves...

To do so, simply add these lines in your ~/.bashrc, right before the line modifying your prompt:

export GIT_PS1_SHOWDIRTYSTATE=true
export GIT_PS1_SHOWUNTRACKEDFILES=true

See the comments at the beginning of /etc/bash_completion.d/git for more details.

Initialize a new repo

mkdir repo && cd repo && git init

Once you've created a repo, you'll find a '.git' folder inside it. What you essentially have at this point is a bare repo -- a repository with the git configs, but no actual files contained in the repository. Now let's create a file and tell git that we want it to be part of our repo. From the repo directory (not the .git directory), type:

echo "Blah" > test.txt

git add test.txt

We can then commit the changes by typing:

git commit test.txt

Another way of committing all the changes (without having to specify all the files that have changed) is to type:

git commit -a

Either way, it will bring up whichever editor you have defined in $EDITOR and allow you to write a commit log message explaining the changes you've made. A commit log message usually consists of:

  • a one-line summary of your changes
  • a blank line
  • one or more additional lines with more detail. These lines are optional.

You can always check the status of your current repo by typing

git status

Developer Operations

Create a new local branch

git checkout -b <branch>

Push and create a new remote branch from an existing local branch of the same name

git push origin <branch>

Switch to a branch that was pushed remotely

Use:

git branch -r

to determine the name of the upstream branch you want to work on. Then use this to switch to it:

git checkout --track origin/<branch>

This creates a local branch named <branch> and tells git that it came from origin/<branch>. Using git status will show you whether your local branch is ahead, behind, or otherwise different than the upstream branch.

If you want to use a different name for your local branch, you can use:

git checkout --track --branch <some-other-name> origin/<branch>

Maintainer Operations

Remove a remote branch

Warning (medium size).png
This is a dangerous operation.
If there's any chance that other people are using the remote branch, you should at least warn them before doing this.
Warning (medium size).png
This doesn't entirely work right now for Fedora pkgs git
This may give a (hook denied) error. See [1] for details.

Assuming you had a branch named blah on the remote server, you could remove it by typing:

git push origin :blah

Apply mailed git patch

git am <file>