The Ultimate Guide to High Availability with MariaDB

Using Git

You are viewing an old version of this article. View the current version here.

Contents

  1. Setup
  2. Commit comments
  3. Branches
    1. List existing branches
    2. To move to work on a specific branch
    3. Making a local copy of a branch (like bzr clone)
    4. Remove last commit from a branch
    5. Other things about branches
  4. Equivalents for some bzr commands
  5. Commit emails
  6. Examples
    1. Applying new code from main tree to a branch
    2. Applying a bugfix in the main branch
  7. See also

Setup

  • Set your name with git 
git config --global user.name "Ivan Ivanov"
git config --global user.email "[email protected]"
  • Clone the repository 
git clone [email protected]:MariaDB/server.git
cd server
  • Run git branch to check that you're working on MariaDB 10.1: 
server $ git branch
* 10.1

Commit comments

In git commit messages are normally formatted as

subject

body
more body
...

That is, the first line is considered a *subject*, much like email subject. Many git commands and pages on github only show the commit subject, not the complete comment. After the subject goes an empty line, then the detailed description of the comment. Please, structure your commit comments this way, don't forget the empty line.

Branches

This is an important concept, and git branches do not have equivalents in bzr.

In Bazaar, we all used to have one shared repository, within which there were many branches. This seems to be impossible with git?

In Git, each repository has only one branch that is currently checked out. 

git branch

List existing branches

To see which branches exists locally and remotely:

git branch --all

To move to work on a specific branch

git checkout branch-name

Note that if the output from git branch --all is remotes/origin/XXX you should just use XXX as branch name.

Making a local copy of a branch (like bzr clone)

branch clone old_directory new_directory
cd new_directory
git remote set-url origin [email protected]:MariaDB/server.git
git pull

Remove last commit from a branch

git reset --hard HEAD^

Other things about branches

  • Note: branches whose names start with bb- are automatically put into the buildbot.

Equivalents for some bzr commands

CAVEAT UTILITOR. Check the manual before running!

  • bzr status is git status
  • bzr diff is git diff
  • bzr log is git log
  • bzr revert is git reset --hard
  • bzr revert filename is git checkout filename
  • bzr revert is git reset --hard
  • bzr parent is git remote -v (but there are more detailed commands)
  • bzr parent to-default-mariadb-repo git remote set-url origin [email protected]:MariaDB/server.git
  • bzr push is git push REMOTENAME BRANCHNAME. REMOTENAME is typically "origin", for example: git push origin 10.1-new-feature
  • bzr clean-tree --ignored is git clean -Xdf (note the capital X!)
  • bzr root is git rev-parse --show-toplevel
  • bzr missing --mine-only is git cherry -v origin (kind-of).

GUIs

  • bzr gcommit is git citool
  • bzr viz is gitk
  • bzr gannotate is git gui blame

Commit emails

In the MariaDB project, it is a good idea (and a long tradition since MySQL Ab) to have all your commits sent to a [email protected] mailing list. It allows others to follow the progress, comment, etc.

A script and instructions on how to setup commit triggers in Git are here: http://bazaar.launchpad.net/~maria-captains/mariadb-tools/trunk/files/head:/git_template/ . Jira task for commit trigger was MDEV-6278.

Examples

Applying new code from main tree to a branch

You are working on a branch (NEW_FEATURE) and would like to have into that branch all changes from the main branch (10.1).

git checkout 10.1
git pull
git checkout NEW_FEATURE
git rebase 10.1

Applying a bugfix in the main branch

You've just fixed a bug in the main 10.1 branch and want to merge it with the latest 10.1. Often a rebase is better in this case. Assuming your current checked out branch is 10.1:

git fetch origin
git rebase origin/10.1

See also

Comments

Comments loading...
Content reproduced on this site is the property of its respective owners, and this content is not reviewed in advance by MariaDB. The views, information and opinions expressed by this content do not necessarily represent those of MariaDB or any other party.