Development using git: Difference between revisions

From Alpine Linux
No edit summary
(37 intermediate revisions by 9 users not shown)
Line 1: Line 1:
[http://git.or.cz Git] is now being used for version control of the [http://dev.alpinelinux.org/cgit/cgit.cgi/alpine-baselayout/ alpine-baselayout] and [http://dev.alpinelinux.org/cgit/cgit.cgi/alpine-conf alpine-conf] packages.
{{Move|Git|All git development articles should be consolidated}}


== Git Clone  ==
This document describes how to use [http://git-scm.com git] for Alpine Linux development and related projects. If you just want to browse the Alpine git repositories, please visit [http://git.alpinelinux.org/cgit/aports git.alpinelinux.org].


To get started, clone the [http://dev.alpinelinux.org/cgit git repository] for the package you are interested in:
== Basic Git usage ==


  git clone git://git.alpinelinux.org/alpine-baselayout
{{:Development_using_git:Configuration}}
  git clone git://git.alpinelinux.org/alpine-conf


Make your changes.  
{{Tip| If you want to use git with colored output use:
{{Cmd|git config --global color.ui true
git config --global core.pager more}}
}}


To prepare a patch:  
{{Tip| If you want to use git with proxy server:
{{Cmd|git config --global http.proxy http://proxy_ip:proxy_port}}
}}


git diff > short-description-of-change.patch
{{:Development_using_git:Email}}


This diff can be sent to [mailto:alpine-devel@lists.alpinelinux.org alpine-devel@lists.alpinelinux.org] mailing list.
== Cloning a repository via Git ==


== Migrate a subversion repository to git ==
There are two ways to work with the Alpine git repository...


Start with creating a users.txt file where the svn users are mapped to an email address for git.  
* ...without write access.
* ...with write access.


echo "ncopa = Natanael Copa <ncopa@example.com>" > users.txt
[http://git.alpinelinux.org/cgit/aports git.alpinelinux.org] shows all available Alpine git repositories.


Create a temp work area.
=== Without write access ===


  mkdir proj-tmp
If you want to clone the Alpine aports repository, switch to the directory you want to have the ''aports/'' directory in and launch git.
   
{{Cmd|git clone git://git.alpinelinux.org/aports.git}}


Init the git repository. If your svn repo does not have the standard trunk branches and tags dirs you shouldnt use the --stdlayout. You can also use -T trunk -b branches -t tags.  
{{Tip| If you are using proxy server:
{{Cmd|git clone http://git.alpinelinux.org/cgit/aports}}
}}


cd proj-tmp
If you want only the last 3 revisions:
git svn init svn://svn.alpinelinux.org/proj --stdlayout


Connect the users.txt to the empty git repository so users are remapped.
{{Cmd|git clone git://git.alpinelinux.org/aports.git --depth 3}}


git config svn.authorsfile ../users.txt
Use the command below to see the full log of the trunk.  


Fetch and import the svn repository. This might take some time.
{{Cmd|git log}}


git fetch
=== With write access ===


Now we can create a bare repository and upload it to dev.alpinelinux.org/gitroot.
If you have write access to the Alpine repository, the URL needs to be adjusted for cloning a repository


cd ..
{{Cmd|git clone git@git.alpinelinux.org:aports}}
git clone --bare proj-tmp proj.git
scp -r proj.git dev.alpinelinux.org:/gitroot


== References  ==
Alternatively you can set the remote url of an exisiting git clone:
{{Cmd|git remote set-url origin git@git.alpinelinux.org:aports}}


Some useful documents
== General GIT Workflow ==
# Make your file edits in your local checkout of the local copy of repository.
# Commit the changes in your local repository: {{Cmd|git commit}}
# Bring the rest of your local repository up to date: {{Cmd|git pull --rebase}}
# Check what you are going to push: {{Cmd|git log origin..master}}
# Move your changes up to the master if you have write access {{Cmd|git push}} or [[Creating_patches|create a patch]] if not.


*[http://git.or.cz/course/svn.html Git - SVN Crash Course] (quickstart if you know svn)
== Other related articles ==
*[http://cworth.org/hgbook-git/tour/ A tour of git: the basics] '''Recommended'''
 
*[http://book.git-scm.com/ The Git Community Book]  
* [[Development_using_git:Basic_usage| Basic usage]]
*[http://www.newartisans.com/blog/2008/04/git-from-the-bottom-up.html Git from the bottom up]
* [[Package Maintainers]]
* [[Creating patches]]
* [[Development_using_git:Developer_repositories|Developer repositories]]
* [[Development_using_git:Cgit| Using Cgit]]
* [[Development using git:Quality assurance]]
* [[Gitolite]]
 
== Further reading ==
{{:Development_using_git:Documentation}}
 
[[Category:Development]]
[[Category:Git]]

Revision as of 15:02, 30 April 2019

This page is proposed for moving ...

It should be renamed to Git. All git development articles should be consolidated (Discuss)

This document describes how to use git for Alpine Linux development and related projects. If you just want to browse the Alpine git repositories, please visit git.alpinelinux.org.

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

Using git config without --global let you configure other details for a specific git repository.

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

git config --global color.ui true git config --global core.pager more

Tip: If you want to use git with proxy server:

git config --global http.proxy http://proxy_ip:proxy_port

Development using git:Email

Cloning a repository via Git

There are two ways to work with the Alpine git repository...

  • ...without write access.
  • ...with write access.

git.alpinelinux.org shows all available Alpine git repositories.

Without write access

If you want to clone the Alpine aports repository, switch to the directory you want to have the aports/ directory in and launch git.

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

Tip: If you are using proxy server:

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

If you want only the last 3 revisions:

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

Use the command below to see the full log of the trunk.

git log

With write access

If you have write access to the Alpine repository, the URL needs to be adjusted for cloning a repository

git clone git@git.alpinelinux.org:aports

Alternatively you can set the remote url of an exisiting git clone:

git remote set-url origin git@git.alpinelinux.org:aports

General GIT Workflow

  1. Make your file edits in your local checkout of the local copy of repository.
  2. Commit the changes in your local repository:

    git commit

  3. Bring the rest of your local repository up to date:

    git pull --rebase

  4. Check what you are going to push:

    git log origin..master

  5. Move your changes up to the master if you have write access

    git push

    or create a patch if not.

Other related articles

Further reading