From b371875e02cce2fb3fbb9fbb8f07eb5817ae0e8f Mon Sep 17 00:00:00 2001
From: Thibault Saunier <thibault.saunier@osg.samsung.com>
Date: Wed, 29 Mar 2017 15:03:43 -0300
Subject: docs: Import the website and wiki and build with hotdoc

This allows us to more easily have the documentation in sync with
the source code as people will have to document new features etc
right at the time where they implement it.
---
 docs/markdown/Vala.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 78 insertions(+)
 create mode 100644 docs/markdown/Vala.md

(limited to 'docs/markdown/Vala.md')

diff --git a/docs/markdown/Vala.md b/docs/markdown/Vala.md
new file mode 100644
index 000000000..00df3719d
--- /dev/null
+++ b/docs/markdown/Vala.md
@@ -0,0 +1,78 @@
+---
+title: Vala
+...
+
+# Compiling Vala applications
+
+Meson has support for compiling Vala programs. A skeleton Vala file looks like this.
+
+```meson
+project('valaprog', ['vala', 'c'])
+
+glib = dependency('glib-2.0')
+gobject = dependency('gobject-2.0')
+
+executable('valaprog', 'prog.vala',
+           dependencies : [glib, gobject])
+```
+
+You must always specify `glib` and `gobject` as dependencies, because all Vala applications use them.
+
+## Using a custom VAPI
+
+When dealing with libraries that are not providing Vala bindings, you can point --vapidir to a directory relative to meson.current_source_dir containing the binding and include a --pkg flag.
+
+```meson
+glib = dependency('glib-2.0')
+gobject = dependency('gobject-2.0')
+foo = dependency('foo')
+
+executable('app',
+           dependencies: [glib, gobject, foo]
+           vala_args: ['--pkg=foo', '--vapidir=' + meson.current_source_dir()])
+```
+
+## GObject Introspection
+
+To generate GObject Introspection metadata, the --gir flags has to be set explicitly in vala_args.
+
+```meson
+foo_lib = library('foo',
+                  dependencies: [glib, gobject],
+                  vala_args: ['--gir=Foo-1.0.gir'])
+```
+
+For the typelib, use a custom_target depending on the library:
+
+```meson
+    g_ir_compiler = find_program('g_ir_compiler')
+    custom_target('foo-typelib',
+                   command: [g_ir_compiler, '--output', '@OUTPUT@', meson.current_build_dir() + '/foo@sha/Foo-1.0.gir'],
+                   output: 'Foo-1.0.typelib',
+                   depends: foo_lib,
+                   install: true,
+                   install_dir: get_option('libdir') + '/girepository-1.0')
+```
+
+## Installing VAPI and GIR files
+
+To install generated VAPI and GIR files, it is necessary to add a custom install script.
+
+```meson
+meson.add_install_script('install.sh')
+```
+
+```bash
+#!/bin/sh
+
+mkdir -p "${DESTDIR}${MESON_INSTALL_PREFIX}/share/vala/vapi"
+mkdir -p "${DESTDIR}${MESON_INSTALL_PREFIX}/share/gir-1.0"
+
+install -m 0644                                         \
+    "${MESON_BUILD_ROOT}/foo-1.0.vapi" \
+    $"{DESTDIR}${MESON_INSTALL_PREFIX}/share/vala/vapi"
+
+install -m 0644                            \
+    "${MESON_BUILD_ROOT}/foo@sha/Foo-1.0.gir" \
+    "${DESTDIR}${MESON_INSTALL_PREFIX}/share/gir-1.0"
+```
-- 
cgit v1.2.3