diff options
author | Thibault Saunier <thibault.saunier@osg.samsung.com> | 2017-03-29 15:03:43 -0300 |
---|---|---|
committer | Jussi Pakkanen <jpakkane@gmail.com> | 2017-04-26 17:56:33 +0300 |
commit | b371875e02cce2fb3fbb9fbb8f07eb5817ae0e8f (patch) | |
tree | 6e1a3c34b1a85479d3b9f42ccd071096e637929b /docs/markdown/Pkg-config-files.md | |
parent | 7dc747ea54480c452b913e4bfe682ec67061c9bf (diff) | |
download | meson-b371875e02cce2fb3fbb9fbb8f07eb5817ae0e8f.zip meson-b371875e02cce2fb3fbb9fbb8f07eb5817ae0e8f.tar.gz meson-b371875e02cce2fb3fbb9fbb8f07eb5817ae0e8f.tar.bz2 |
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.
Diffstat (limited to 'docs/markdown/Pkg-config-files.md')
-rw-r--r-- | docs/markdown/Pkg-config-files.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/markdown/Pkg-config-files.md b/docs/markdown/Pkg-config-files.md new file mode 100644 index 0000000..bac90bc --- /dev/null +++ b/docs/markdown/Pkg-config-files.md @@ -0,0 +1,19 @@ +# Pkg config files + +[Pkg-config](https://en.wikipedia.org/wiki/Pkg-config) is a way for shared libraries to declare the compiler flags needed to use them. There are two different ways of generating Pkg-config files in Meson. The first way is to build them manually with the `configure_files` command. The second way is to use Meson's built in Pkg-config file generator. The difference between the two is that the latter is very simple and meant for basic use cases. The former should be used when you need to provide a more customised solution. + +In this document we describe the simple generator approach. It is used in the following way. + +```meson +pkg = import('pkgconfig') +libs = ... # the library/libraries users need to link against +h = ['.', ...] # subdirectories of ${prefix}/${includedir} to add to header path +pkg.generate(libraries : libs, + subdirs : h, + version : '1.0', + name : 'libsimple', + filebase : 'simple', + description : 'A simple demo library.') +``` + +This causes a file called `simple.pc` to be created and placed into the install directory during the install phase. |