From BaseX Documentation
 Using Git to contribute to BaseX
Our team uses git and GitHub to manage the source code. All team members have read+write access to the repository, and external contributors are welcome to fork the project.
Git makes it easy to retain a full copy of the repository for yourself. To get started and running, simply fork BaseX. If forking sounds unfamiliar to you, we suggest to check out the git introduction below.
You can then build BaseX with Maven. Using Eclipse is optional.
 Using Git & Eclipse
- (Optional) Head over to https://github.com/BaseXdb and create an account
- Fork BaseX, so you have a version on your own
- Make yourself familiar with git (see the end of this page)
- Open Eclipse
- Install egit (Eclipse: Help → Marketplace → Search for egit or get it from http://www.eclipse.org/egit/)
 Create the project
 EGit & SSH
EGit uses the JSch library which is, however, reported to have problems with RSA SSH keys in linux and possibly other platforms. A solution would be to use the variable GIT_SSH and assign it a path to the native SSH executable. According to this change in EGit, the plugin will try to use a native SSH implementation instead of JSch (this, however, may not always work either :( ).
 Using Git on Command-Line
Note: this is not intended to be a complete git reference; it's purpose is to quickly introduce BaseX developers to the most commonly used git commands in the context of the BaseX project.
 Clone Your Personal Repository
$ git clone firstname.lastname@example.org:$username/$project.git Cloning into $project... Enter passphrase for key '/home/user/.ssh/id_rsa': ... $ ls -d -1 $PWD/* /home/user/myprojects/$project
Note that git automatically creates a directory where the repository content will be checked out.
 List Remote Repositories
$ git remote -v origin email@example.com:$username/$project.git (fetch) origin firstname.lastname@example.org:$username/$project.git (push)
Currently, there is only one remote repository; it is automatically registered during the clone operation. Git remembers this repository as the default repository for push/pull operations.
 List Local Changes
After some files have been changed locally, the changes can be seen as follows:
$ git diff diff --git a/readme.txt b/readme.txt index fabaeaa..cd09568 100644 --- a/readme.txt +++ b/readme.txt @@ -49,6 +49,10 @@ ADDING CHECKSTYLE -------------------------------------------------------------- - Enter the URL: http://eclipse-cs.sourceforge.net/update - Follow the installation procedure and restart Eclipse +USING GIT ---------------------------------------------------------------------- Any kind of feedback is welcome; please check out the online documentation at
 Commit to Local Repository
Note: this commit operation does not commit into the remote repository!
First, it is needed to select the modified files which should be committed:
$ git add readme.txt
Then perform the actual commit:
$ git commit [master 0fde1fb] Added TODO in section "USING GIT" 1 files changed, 4 insertions(+), 0 deletions(-)
Before executing the actual commit, git will open the default shell editor (determined using the $EDITOR variable, usually vi) to enter a message describing the commit changes.
Alternative way is to commit all changed files, i. e. it is not needed to explicitly add the changed files:
$ git commit -a [master 0fde1fb] Added TODO in section "USING GIT" 1 files changed, 4 insertions(+), 0 deletions(-)
 Pushing Local Changes to Remote Repository
$ git push Enter passphrase for key '/home/user/.ssh/id_rsa': Everything up-to-date
 Pulling Changes from Remote Repository
$ git pull Enter passphrase for key '/home/user/.ssh/id_rsa': Already up-to-date.
 Add BaseXdb Upstream Repository
The upstream repository is the one from which the BaseX releases are made and the one from which the personal repository was forked.
$ git remote add upstream email@example.com:BaseXdb/$project.git $ git remote -v origin firstname.lastname@example.org:$username/$project.git (fetch) origin email@example.com:$username/$project.git (push) upstream firstname.lastname@example.org:BaseXdb/$project.git (fetch) upstream email@example.com:BaseXdb/$project.git (push)
 Pulling Changes from Upstream to Local Repository
When some changes are made in the upstream repository, they can be pulled to the local repository as follows:
$ git pull upstream master Enter passphrase for key '/home/user/.ssh/id_rsa': From github.com:BaseXdb/$project * branch master -> FETCH_HEAD Already up-to-date.
The changes can then be pushed in the personal repository:
$ git push
Check out the links at the end of the page for more git options.
 Need help using git?
For information on how to install git on various platforms please refer to: GitHub: git Installation Guide