De Dolibarr Wiki.

Retour index
Documentation développeur

This is informations on how you can get sources of Dolibarr project.

Get last version of sources by download

This method allows you to get sources of main development branch (called HEAD): This operation consist to get last version of Dolibarr files that are packaged each night into a tgz file. For this, go on page with last source version of the day.

New files overwrite old ones. The inconvenient of this method is that you must download and uncompress package each time you want to get updates.

Get last version of sources using a GIT anonymous access

Prerequisite

First you must have a working install of Eclipse. EGit plugin must also have been installed. For this, use the Find And Install process into Eclipse menu, add the GIT update URL:

http://download.eclipse.org/egit/updates

Then choose to install EGit.

To get sources with goal to edit them, you need a GitHub write access to the GIT remote repository, and a GIT client (GIT command line tool with Linux, or the GIT client in Eclipse). See next chapter for this.

First, enter value of the repository with reference sources into your GIT client tool.

• With Eclipse, choose "Clone GIT repository". Enter GIT URL of project to get.

GIT Url for Dolibarr official source is:

git://github.com/Dolibarr/dolibarr.git

Your Eclipse GIT client will ask you to choose the branches you are interesting in. Branches not selected now could be selected later by doing a "Fetch" from the "Remotes" view, but try to choose only the branch you need. This will save you time and problems later.

• With GIT on Command Line Interface:

First setup your git client:

git config --global user.name "Your Name"
git config --global user.email "user@domain.com"
git config --list

Then clone repository locally:

git clone git://github.com/Dolibarr/dolibarr.git dolibarr

And, if you are behind a firewall, you can user the alternate URL:

git config --global http.proxy http://proxyuser:proxypass@proxyserver:proxyport
git clone https://gitlogin:gitpassword@github.com/Dolibarr/dolibarr.git dolibarr

Once this step is validated, your GIT client will download all files from remote GIT server. This may last several seconds or minutes.

Once download is finished, go into GIT view - Branches - Local. In most cases, the branch you choosed should be already available.

If not:

• With Eclipse, right click on "Branches - Remotes - The branch you want to duplicate locally".

If you choose "Create Branch", this will duplicate content of branch to work on it locally. If you Choose "Checkout", this will update the view "Working Directory".

• With GIT on Command Line Interface;

git checkout develop
git checkout x.y

This will create local branch and make checkout automatically.

If using Eclipse, once your branch is created locally, create a PHP project from assistant by choosing "Create from existing project" and select directory that is your GIT local repository (Do not choose to create a PHP project from scratch). Then right click on project from your Eclipse workspace and Choose "Team - Share". Select GIT and click on option "Use or create repository in parent folder of project". An alternate method is File->Import, Git->Project from Git, Select the Git repository and Next, Use New project Wizard -> Php project, enter the folder of you GIT local repository.

Then, you can setup Eclipse to avoid it to scan all project files for its build tools (Outline scanner, TODO scanner, syntax scanner...). This will avoid Eclipse to be too slow. For this, right click on project, choose Build Path and setup it like into following screenshot.

Get last version of sources using a full GIT access

Prerequisite

First you must have a working install of Eclipse. EGit plugin must also have been installed. For this, use the Find And Install process into Eclipse menu, add the GIT update URL:

http://download.eclipse.org/egit/updates

Then choose to install EGit.

You must before create an account on GitHub (https://github.com/) and upload a public RSA or DSA certificate into your account profile.

Then process is same than getting sources with anonymous access.

URL to use for GIT clone is same:

git@github.com:Dolibarr/dolibarr.git

Note that a HTTP URL is also available but it's sometimes offline (so use first one instead):

https://yourgitlogin@github.com/Dolibarr/dolibarr.git

Update your repository

To update your local workspace, right click on Eclipse project and select "Pull".

If you made some changes into your Eclipse workspace on files that were changed into the GIT remote reference, your GIT client will make a merge automatically.

• If there is conflicts, the merge will mark all conflict files as "conflict" (See later to solve this state).
• If not, you will get all new version files including all your changes.

If you already have commited some files into your local repository, your workspace will be marked as "Merged". All you have to do is make a commit to validate your local repository as including your changes and changes made by others.

Commit and publish your changes

To see all changes you made into your working directory and waiting to be added into Git:

• With GIT Command Line Interface:

git status
git diff subdir/filename

To add changes made into your local repository into the GIT index, then commit this index :

• With Eclipse: Right click on file or directory to commit. Select file to add/remove/update into commit.
• With GIT Command Line Interface:

git commit -a -m "Commit text"

This will save add and changes into your local branch.

To push them on the GIT repository server,

• With Eclipse: right click on project and choose "Team - Push to Upstream".
• With GIT Command Line Interface:

git push

To cancel a commit:

• With GIT Command Line Interface:

git revert IdCommit  or  git revert HEAD  (for last commit)

Add an external commit into current repository

Some developers may work and do commit into their own Git repository after forking the project. If you are interesting into getting this changes, you can import them with the following steps with Eclipse:

• First, go into GIT setup view and right click on "Remotes" of your Eclipse Git working space and choose "Create a remote..."
• Type name or remote fork the developer has create (in most cases, it's developer Git login). For example: "thedevlogin". Choose also "Configure Fetch".
• Type URI of Git repository of developer. For example: git://github.com/thedevlogin/dolibarr.git. Also add a refspec value to declare the branch you want to get. For example: refs/heads/master:refs/remotes/thedevlogin/master. Click "Save and Fetch". A new entry will be added into "Remote Tracking" making possible to read/get commits done into this branch.

Now, go on command line of your git repository (in most cases on Linux, it's /home/yourlogin/git/yourdolibarr) and type the git cherry-pick command:

git cherry-pick -x commitid

where commitid is value of commit id you want to get.

Once this is done, go back to Eclipse and make a refresh on project. You will see modified files appears with decorators (with conflicts if there is).

Solving a conflict

If a file has been marked as "conflict" after a Pull request, open the file to edit it. Find string "<<<<<<<<<<", you will see part of code that is conflict between "<<<<<<<<<" and ">>>>>>>>". Edit manually code lines and remove "<<<<<<<<" and ">>>>>>>".

Then, right click on file and select "Add".

If you prefer to forget completely all changes you made into all files (so to restore you workspace with content of remote repository), you can make a hard reset:

• With Eclipse, right click on project top line and select "Reset" then "Hard" then "Reference - HEAD".
• Using GIT command line tool, you can achieve this with command

git reset --hard HEAD

Tagging sources

To add a tag to a current version:

git tag -m "Tag for x.y.z_YYYYMMDD" "x.y.z_YYYYMMDD"
git push --tags

Creating a new branch

This is command used to start a new branch from a clean develop cloned repository:

git branch x.y
git push origin x.y

Statistics

To count number of changes developers have made between a version x and y:

• First, run git merge-base to know the id of last common commit between x and y

git merge-base origin/3.1 origin/develop

• Then run git log to have list of all changes from last common commit to last commit

git log id_found_at_previous_step..HEAD

• To get total number of added/deleted lines:

git log --ancestry-path --numstat --pretty="%H" id_found_at_previous_step..HEAD | awk 'NF==3 {plus+=$1; minus+=$2} END {printf("+%d, -%d\n", plus, minus)}'

To count number of changes finally between a version x and y (it differs from previous count because in previous count, a change can be done 2 times at two different moment to change differently. With second method, you count change finally found if changes were ok at first try):

• Use same method than previously but instead of running git log, run git diff.

git diff -b -M --numstat --pretty="%H" id_found_at_previous_step..HEAD | awk 'NF==3 {plus+=$1; minus+=$2} END {printf("+%d, -%d\n", plus, minus)}'

More information in GIT usage is available here.