Difference between revisions of "Development using git"

From Alpine Linux
Jump to: navigation, search
(Submitting patches to the alpine-devel mailing list)
(Documentation about git: Fixed broken url)
Line 126: Line 126:
= Documentation about git =
= Documentation about git =
Some other useful documents  
Some other useful documents  
*[http://www.kernel.org/pub/software/scm/git/docs/tutorial.html Git Tutorial]
*[http://www.kernel.org/pub/software/scm/git/docs/ Git Tutorial]
*[http://git.or.cz/course/svn.html Git - SVN Crash Course] (quickstart if you know svn)  
*[http://git.or.cz/course/svn.html Git - SVN Crash Course] (quickstart if you know svn)  
*[http://cworth.org/hgbook-git/tour/ A tour of git: the basics] '''Recommended'''  
*[http://cworth.org/hgbook-git/tour/ A tour of git: the basics] '''Recommended'''  

Revision as of 14:28, 24 October 2010

This document describes how to use git for Alpine Linux development and related projects.

Basic Git usage

Configure your global git config

First you need to tell your name and email to git. This name and email will show up in all your commits.

git config --global user.name "Your Name Comes Here" git config --global user.email you@yourdomain.example.com

Tip: If you want to use git with colored output use:

git config --global color.ui true

To be able send your commits (pathces) via email you need configure an SMTP server.

git config --global sendemail.smtpserver smtp.exmaple.com

For sending from a gmail address you can do:

git config --global sendemail.smtpserver smtp.gmail.com git config --global sendemail.smtpserverport 587 git config --global sendemail.smtpencryption tls git config --global sendemail.smtpuser your_email@gmail.com

Optionally, it is possible to skip the password prompt by adding it to the configuration with:

git config --global sendemail.smtppass your_password

Cloning the repository via Git

git clone git://git.alpinelinux.org/aports.git

The full aports repository is now copied to your aports/.git dir and the latest commit is checked out in aports/. Most operations you do from here will happen on your local copy and will not affect git.alpinelinux.org.

If you want only the last 3 revisions:

git clone git://git.alpinelinux.org/aports.git --depth 3

git log

to see the full log of the trunk.

You can also browse the git repository via cgit.

General GIT Workflow

  1. Make your file edits in your local checkout of the local copy of repository.
  2. git commit the changes in your local repository
  3. git pull --rebase to bring the rest of your local repository up to date
  4. git log origin..master to check what you are going to commit
  5. git push to move your changes up to the master. This requires you have an ssh login and have cloned via ssh://git.alpinelinux.org and not via git://git.alpinelinux.org. (see Development using git with write access)

git stash

if you want to "hide" your changes. Do this if you think there may be other commits against the same things you are working on and want to refresh your local checkout (using a git pull --rebase) from the master. Use git stash apply to get your stash back.

git checkout -f master

if you think your tree is pretty hopeless, need a kill-and-fill to bring the master into your local repository. You will lose local changes.

List the local branch

You can now list your local branch by doing

git branch

which should ouput

* master

List your local non committed changes

git status


Now you can start to work on your tree. As soon as you feel you have reached a step in developement where you can commit your work locally, use

git commit -a


git commit <specific files>


git add <specific files> git commit

If you wish to give credit to someone else's work (e.g. you are applying a third party patch):

git commit <specific files> --author "Name Surname <user@example.com>

The format of the commit message should be:

One-line descrption thats less than 72 chars long
<second line empty>
Optional longer description with explanation why changes were made. Links to relevant issues
in bugtracker can be done with:

  ref #<issuenumber>

It is also possible to resolve issues with:

  fixes #<issuenumber>

Think of first line as the subject in an email and the third line and on as the body of the email, describing what the commit does. You dont need the long description but the first line, the short description should be there as it will be showed in the commit log.

List your commits

git log

Keeping your local working branch in sync

Pull the changes from upstream (git.alpinelinux.org)

git pull --rebase

Submitting patches to the alpine-devel mailing list

To submit the last commit as a patch to alpine-devel mailing list:

git send-email --to alpine-devel@lists.alpinelinux.org HEAD^

The first line in commit message will be subject and the long description (separated with empty line) will be the body in the email.

Note: The git send-email command is provided by the git-perl package

If you have many commits you can create a dir with patches and send them with git send-email.

rm -Rf patches mkdir patches git format-patch -o patches origin git send-email --to alpine-devel@lists.alpinelinux.org patches

If you have multiple patch consider using:

git send-email --compose --no-chain-reply-to --to alpine-devel@lists.alpinelinux.org patches

This will produce the patches for each local commit in the directory "patches" and send them. Use --no-chain-reply-to make sure it doesn't reply.

Don't do:

  • [PATCH 0/m]
    • [PATCH 1/m]
      • [PATCH 2/m]
        • ...

But do:

  • [PATCH 0/m]
    • [PATCH 1/m]
    • [PATCH 2/m]
    • ..

Documentation about git

Some other useful documents