.. _c-api-build:

====================
Building and Testing
====================

:Author:    Stefan Eletzhofer
:Date:      2012-09-27

Abstract
========

This is the **draft** documentation of the *nexiles|gateway C API* build
process.

.. note:: for now we'll develop on the mac.  We'll move to Windows as soon
   as we've sorted the issues with the Windows 7 SDK out.

Test Programs
=============

The development source tree in `src/c-api` contains a makefile which builds
the c-api library and several test programs.  These have lots of assertions
in it and they need to run without errors on each target platform.

The test program does a request to the author's development Windchill
machine -- this will likely fail on a different computer.  This should
probably fixed.

Building
========

To build the library, the examples and the test programs, do::

    $ workon nexiles.tools.api
    $ cd src/c-api
    $ make


External Libraries Used
=======================

.. note:: The install prefix for all development libs is the `build`
   directory.

libcurl
-------
:Home Page: http://curl.haxx.se/
:Version:   7.27.0

This library handles all the gory details of HTTP.

docs
~~~~

**EASY_SETOPT**
    http://curl.haxx.se/libcurl/c/curl_easy_setopt.html

build
~~~~~

Build instructions (OS-X)::

    $ workon nexiles.tools.api
    $ cd vendor/curl-7.27.0
    $ ./configure --prefix $HOME/develop/nexiles/nexiles.tools.api/build
    $ make && make install


jansson
-------
:Home Page: http://www.digip.org/jansson/
:Version:   2.4

A JSON parser.

Build instructions (OS-X)::

    $ workon nexiles.tools.api
    $ cd vendor/jansson-2.4
    $ ./configure --prefix $HOME/develop/nexiles/nexiles.tools.api/build
    $ make && make install

.. vim: set ft=rst tw=75 nocin nosi ai sw=4 ts=4 expandtab: