3 title: Project Architecture
5 https://git.automotivelinux.org/src/cmake-apps-module/plain/docs/dev_guide/project-architecture.md?h=master
8 <!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/devguides/master/cmake-apps-module-guides-devguides-book.yml -->
10 # Project Architecture
12 The following tree structure represents a typical CMake project
30 │ │ │ └── package.spec
33 │ │ ├── debian.package.install
34 │ │ ├── debian.changelog
36 │ │ ├── debian.control
39 │ │ ├── 00-debian-osconfig.cmake
40 │ │ ├── 00-suse-osconfig.cmake
41 │ │ ├── 01-default-osconfig.cmake
54 | File or Directory | Parent | Description |
56 | *root_path* | n/a | CMake project root path. Holds the master CMakeLists.txt file and all general project files.
57 | CMakeLists.txt | The master CMakeLists.txt file.
58 | autobuild/ | *root_path* | Scripts generated from app-templates to build packages the same way for differents platforms.
59 | conf.d/ | *root_path* | Holds needed files to build, install, debug, and package an AGL application project.
60 | packaging/ | conf.d/ | Contains output files used to build packages.
61 | cmake/ | conf.d/ | Minimally contains the config.cmake file, which is modified from the sample provided in the app-templates submodule.
62 | wgt/ | conf.d/ | Contains config.xml.in and optionaly the test-config.xml.in template files that are modified from the sample provided with the CMake module for the needs of the project. For more details, see the config.xml.in.sample and test-config.xml.in.sample files.
63 | *target* | *root_path* | A target to build, which is typically a library or executable.
65 When building projects using CMake, the build process automatically detects
66 the `CMakeLists.txt` and `*.cmake` files.
67 To help with this process, the `PROJECT_SRC_DIR_PATTERN` variable
68 is used for recursive pattern searching from the CMake project's
70 Each sub-folder below *root_path* in the project is searched and included
72 The directories matching the pattern `PROJECT_SRC_DIR_PATTERN` variable
75 **NOTE:** The `PROJECT_SRC_DIR_PATTERN` variable defaults to "*".
77 When the `CMakeLists.txt` file is found, the directory in which it is found
78 is automatically added to the CMake project.
80 Similarly, when a file whose extension is `.cmake` is found, the directory in
81 which that file resides is also added to the CMake project.