From 5dd2fe6e31710bb35960f508e0512d28ef8c5d74 Mon Sep 17 00:00:00 2001 From: Yannis Chatzikonstantinou Date: Tue, 6 Feb 2024 01:11:14 +0200 Subject: [PATCH] update docs --- docs/config.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/config.rst b/docs/config.rst index 3e7957b..b7bcdde 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -68,9 +68,13 @@ The output config defines the output modules that will be used and their options output_header: outputs/header.h output_impl: outputs/header.c header_includes: - - src/tm_enums.h + - outputs/tm_enums.h impl_includes: - - src/header.h + - outputs/header.h + +There are three main generated files that are configured above: A header containing enums (`output_enums`), a header containing function declarations (`output_header`), and an implementation containing function definitions (`output_impl`). + +Of note is that no #include statements for the generated files are generated automatically. This is something that we decided in order to maximize compatibility to edge cases, but may be revised in future Avlos versions. CLI Usage ---------