Commit 17a56b09 authored by Ben Boeckel's avatar Ben Boeckel

ModuleSystem: add high-level overview of the new build system

parent 942e5cae
...@@ -2729,10 +2729,10 @@ endfunction () ...@@ -2729,10 +2729,10 @@ endfunction ()
@ingroup module @ingroup module
@section module-autoinit Autoinit @section module-autoinit Autoinit
When a module contains a registry which may be populated by other modules, When a module contains a factory which may be populated by other modules, these
these registries need to be populated when the modules are loaded by the factories need to be populated when the modules are loaded by the dynamic linker
dynamic linker (for shared builds) or program load time (for static builds). To (for shared builds) or program load time (for static builds). To provide for
provide for this, the module system contains an autoinit "subsystem". this, the module system contains an autoinit "subsystem".
@subsection module-autoinit-leverage Leveraging the autoinit subsystem @subsection module-autoinit-leverage Leveraging the autoinit subsystem
...@@ -2758,7 +2758,7 @@ The @ref vtk_module_autoinit function will generate an include file and provide ...@@ -2758,7 +2758,7 @@ The @ref vtk_module_autoinit function will generate an include file and provide
its path via the `<module>_AUTOINIT_INCLUDE` define. once it has been included, its path via the `<module>_AUTOINIT_INCLUDE` define. once it has been included,
if the `<module>_AUTOINIT` symbol is defined, a header is included which is if the `<module>_AUTOINIT` symbol is defined, a header is included which is
intended to provide the `VTK_MODULE_AUTOINIT` macro. This macro is given the intended to provide the `VTK_MODULE_AUTOINIT` macro. This macro is given the
module name and should use `<module>_AUTOINIT` to fill in the registries in the module name and should use `<module>_AUTOINIT` to fill in the factories in the
module with those from the `IMPLEMENTS` modules listed in that symbol. module with those from the `IMPLEMENTS` modules listed in that symbol.
The `<module>_AUTOINIT` symbol's value is: The `<module>_AUTOINIT` symbol's value is:
......
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment