diff options
| author | Geir Storli <geirst@oath.com> | 2017-10-04 14:35:07 +0200 |
|---|---|---|
| committer | Geir Storli <geirst@oath.com> | 2017-10-04 14:35:07 +0200 |
| commit | 425cd4a88c66510914fb5b34ce980c785389f64d (patch) | |
| tree | 2439bc9e9a1898114c13630f7facb953fafe71e3 /vagrant | |
| parent | f1a0d47ae4945a37f22219347825fc5d22cd6678 (diff) | |
Add section on development using CLion.
Diffstat (limited to 'vagrant')
| -rw-r--r-- | vagrant/README.md | 42 |
1 files changed, 36 insertions, 6 deletions
diff --git a/vagrant/README.md b/vagrant/README.md index 02d11900558..1ca811f982d 100644 --- a/vagrant/README.md +++ b/vagrant/README.md @@ -7,22 +7,52 @@ ## Create dev environment -### Change working directory to <vespa-source>/vagrant +1. Change working directory to <vespa-source>/vagrant cd <vespa-source>/vagrant -### Start and provision the environment +1. Install Vagrant VirtualBox Guest Additions plugin +This is required for mounting shared folders and get mouse pointer integration and seamless windows in the virtual CentOS desktop. + + vagrant plugin install vagrant-vbguest + +1. Start and provision the environment vagrant up -### Connect to machine via SSH +1. Connect to machine via SSH SSH agent forwarding is enabled to ensure easy interaction with GitHub inside the machine. vagrant ssh -### Checkout vespa source inside machine -This is needed in order to compile and run tests fast on the local file system inside the machine. +1. Checkout vespa source inside virtual machine +This is needed in order to compile and run tests fast on the local file system inside the virtual machine. git clone git@github.com:vespa-engine/vespa.git ## Build C++ modules -Please follow the instructions described [here](../README.md#build-c-modules). +Please follow the build instructions described [here](../README.md#build-c-modules). +Skip these steps if doing development with CLion. + + +## Build and Develop using CLion +CLion is installed as part of the environment and is recommended for C++ development. + +1. Bootstrap C++ building +Go to <vespa-source> directory and execute: + + ./bootstrap-cpp.sh . . + +1. Start CLion +Open a terminal inside the virtual CentOS desktop and run: + + clion + +1. Open the Vespa Project +Go to *File* -> *Open* and choose <vespa-source>/CMakeLists.txt. + +1. Set compiler threads +Go to *File* -> *Settings* -> *Build, Execution, Deployment* -> *CMake*. +Under *Build Options* specify "-j 4" and click *Apply*. + +1. Build all modules +Choose target **all_modules** from the set of build targets and click build. |