Skip to content

Commit

Permalink
Merge pull request #2942 from kodebach/codegen_doc
Browse files Browse the repository at this point in the history
Minor documentation updates
  • Loading branch information
markus2330 committed Sep 9, 2019
2 parents 95907d8 + 4168303 commit 8bef05c
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 4 deletions.
1 change: 1 addition & 0 deletions cmake/ElektraConfig.cmake.in
Expand Up @@ -66,6 +66,7 @@ set (Elektra_STATIC @BUILD_STATIC@)
# If <output_dir> is not set explicitly, it defaults to `CMAKE_CURRENT_BINARY_DIR`. # If <output_dir> is not set explicitly, it defaults to `CMAKE_CURRENT_BINARY_DIR`.
# `<params>...` and `<options>...` are omitted from the `kdb gen` call, if they aren't defined. # `<params>...` and `<options>...` are omitted from the `kdb gen` call, if they aren't defined.
# #
# Full examples can be found online: https://master.libelektra.org/examples/codegen
# ~~~ # ~~~
function (elektra_kdb_gen function (elektra_kdb_gen
template template
Expand Down
4 changes: 1 addition & 3 deletions doc/help/elektra-highlevel-gen.md
Expand Up @@ -7,11 +7,9 @@ with the basic features explained in [`kdb-gen-highlevel(1)`](kdb-gen-highlevel.


The parameters that are relevant to the concepts described here are (for the rest see [`kdb-gen-highlevel(1)](kdb-gen-highlevel.md)): The parameters that are relevant to the concepts described here are (for the rest see [`kdb-gen-highlevel(1)](kdb-gen-highlevel.md)):


- `enumConv`: allowed values: `strcmp`, `switch`, `auto` (default)
- `embeddedSpec`: allowed values: `full` (default), `defaults`, `none` - `embeddedSpec`: allowed values: `full` (default), `defaults`, `none`
- `specValidation`: allowed values: `none` (default), `minimal` - `specValidation`: allowed values: `none` (default), `minimal`

- `enumConv`: allowed values: `strcmp`, `switch`, `auto` (default)
The `enumConv` option is described [below](#enums).


Using `embeddedSpec` you can configure how much of the specification is embedded into your application. By default we use `full`. This means Using `embeddedSpec` you can configure how much of the specification is embedded into your application. By default we use `full`. This means
the full specification is embedded into your application's binary. Since this can drastically increase the size of the binary, you can also the full specification is embedded into your application's binary. Since this can drastically increase the size of the binary, you can also
Expand Down
2 changes: 1 addition & 1 deletion doc/news/_preparation_next_release.md
Expand Up @@ -38,7 +38,7 @@ If you specifically want to use it with the High-Level API take a look at [this


We also created a new CMake function that will be available, if you include Elektra via CMake's We also created a new CMake function that will be available, if you include Elektra via CMake's
`find_package`. The function is called `elektra_kdb_gen` and can be used to tell CMake about files `find_package`. The function is called `elektra_kdb_gen` and can be used to tell CMake about files
that are generated via `kdb gen`. _(Klemens Böswirth)_ that are generated with `kdb gen`. _(Klemens Böswirth)_


### <<HIGHLIGHT2>> ### <<HIGHLIGHT2>>


Expand Down

0 comments on commit 8bef05c

Please sign in to comment.