Index

NeurospacesRepositoryAndTheInstaller

G3 Doc: developers-intro.tex

Introduction

For the federated development of the software components of the neurospaces project and other software components a software buildbot machine houses a monotone server that is connectible over the internet. Source code changes can be properly merged using the functions available on monotone, regardless of the location where the changes have been made (at home, in your office, on the airplane). The build mechanism will always build the most up to date version of the code.

Convenient Access to the Source Code

The most easy way to get the latest version of the source code is via the Neurospaces installer. See NeurospacesRepositoryAndTheInstaller for more information.

The information below explains how to checkout code manually when not using the installer.

Serving your source code

If you want someone else to sync their code with what you have on your laptop, you can conveniently convert your laptop to a source code server using the command neurospaces_serve (see the InstallerPackage). Other people can now connect to your laptop using eg. neurospaces_sync --repo-sync <ip-address-of-your-laptop> or neurospaces_pull --repo-pull <ip-address-of-your-laptop>. All these commands accept a --regex <package-regex> to select packages to serve, sync and pull respectively.

To interrupt the server, kill all the server processes using neurospaces_kill_servers.

Checking out Code Manually

To check out the latest version of the neurospaces project code you must first initialize a local monotone repository via this command:

mtn --db=myrepo.mtn db init

There are monotone instances running for different parts of neurospaces on different ports. To target the correct component you want you need to use these arguments for the remote server:

To pull the code from the monotone server into your working repository via the command.

mtn --db=myrepo.mtn pull repo-genesis3.cbi.utsa.edu:<port#> "*"

The "*" argument pulls all branches from the server into your local repository. To pull a specific branch look at the next section. It's important that each server be synced to it's own local repository. Once the code has been pulled you can checkout one of the branches into your working directory via the command:

mtn --db=myrepo.mtn --branch=<Branch ID> co source_directory

Syncing Databases

To sync your monotone repository to the remote server you'll need to use the sync command with the proper address of the server (as listed above).

mtn --db=myrepo.mtn sync repo-genesis3.cbi.utsa.edu:<port#> "*"

Now all changes, including logs will be on both the client and server repositories. Note in order to perform this operation you need to be given write access to the repositories on virtual2.

Branches

Since you must know the desired branch you want when pulling a specific branch, here are the branches available on the monotone server.

Neurospaces Genesis SLI - 0

If you download all branches via the "*" argument you can get a list of what branches are available to check out from your local repository via the command:

mtn --db=myrepo.mtn list branches

Committing Changes

A monotone repository is an annotated database and every change that is made is signed with keys. To be able to commit changes to your local monotone repository you need to generate a key pair. To do this execute the command:

mtn genkey email@address.com

This stores a private key for yourself in ~/.monotone. It will ask you to enter a passphrase which you'll use to verify your identification when you check in changes. To see all the keys monotone has stored you can do a:

mtn list keys

and also an

mtn --db=myrepo.mtn list keys

To commit the changes you made to your own database repository; inside of the source directory execute:

mtn ci or mtn commit

Repository Access

To get write access to a repository which you did not initiate, it must be signed with your public key.

To export your public key perform the following comment:

mtn --db=repo.mtn pubkey my@email.com > me.pubkey

Send the repository owner your public key for write access. To perform this you must have monotone read in the key from stdin with the read command:

cat me.pubkey | mtn --db=repo.mtn read

If it is successful it will indicate that it read in a packet. You can input several keys in a file this way and it will indicate the number of successful packets read in.