Added documentation.

pull/2764/head
Jussi Pakkanen 7 years ago
parent 658442bef4
commit 34c03719a3
  1. 13
      docs/markdown/Reference-manual.md
  2. 21
      docs/markdown/snippets/gen-subdirs.md

@ -1688,11 +1688,18 @@ This object is returned by [`generator()`](#generator) and contains a
generator that is used to transform files from one type to another by generator that is used to transform files from one type to another by
an executable (e.g. `idl` files into source code and headers). an executable (e.g. `idl` files into source code and headers).
* `process(list_of_files)` takes a list of files, causes them to be * `process(list_of_files, ...)` takes a list of files, causes them to
processed and returns an object containing the result which can be processed and returns an object containing the result which can
then, for example, be passed into a build target definition. The then, for example, be passed into a build target definition. The
keyword argument `extra_args`, if specified, will be used to replace keyword argument `extra_args`, if specified, will be used to replace
an entry `@EXTRA_ARGS@` in the argument list. an entry `@EXTRA_ARGS@` in the argument list. The keyword argument
`preserve_path_from`, if given, specifies that the output files need
to maintain their directory structure inside the target temporary
directory. The most common value for this is
`meson.current_source_dir()`. With this value when a file called
`subdir/one.input` is processed it generates a file `<target private
directory>/subdir/one.out` as opposed to `<target private
directory>/one.out`.
### `subproject` object ### `subproject` object

@ -0,0 +1,21 @@
## Generator outputs can preserve directory structure
Normally when generating files with a generator, Meson flattens the
input files so they all go in the same directory. Some code
generators, such as Protocol Buffers, require that the generated files
have the same directory layout as the input files used to generate
them. This can now be achieved like this:
```meson
g = generator(...) # Compiles protobuf sources
generated = gen.process('com/mesonbuild/one.proto',
'com/mesonbuild/two.proto',
preserve_path_from : meson.current_source_dir())
This would cause the following files to be generated inside the target
private directory:
com/mesonbuild/one.pb.h
com/mesonbuild/one.pb.cc
com/mesonbuild/two.pb.h
com/mesonbuild/two.pb.cc
Loading…
Cancel
Save