diff options
author | 2022-01-26 12:25:31 +0100 | |
---|---|---|
committer | 2022-02-02 11:50:02 +0000 | |
commit | 8160b5cdc8547277f3f31ee1e41524754d5d987d (patch) | |
tree | 6ebbcfa9802c82de6b552733ef53d411247e1cdd /docs/3_Developer_Guides/5_Using_CMAKE_Applications_Module/1_Project_Architecture.md | |
parent | 835363f430c5dee0b53b7c415572cdfdcc02ad18 (diff) |
Update to documentation before Marlinmarlin_12.92.0marlin/12.92.012.92.0
This is mostly a cleanup before the Magic Marlin Release.
We do have the Application Framework chapter rewrite pending.
Bug-AGL: SPEC-4236
Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org>
Change-Id: I7e1f39667b4db417497b1d0c84065c173fa18439
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27097
Diffstat (limited to 'docs/3_Developer_Guides/5_Using_CMAKE_Applications_Module/1_Project_Architecture.md')
-rw-r--r-- | docs/3_Developer_Guides/5_Using_CMAKE_Applications_Module/1_Project_Architecture.md | 74 |
1 files changed, 0 insertions, 74 deletions
diff --git a/docs/3_Developer_Guides/5_Using_CMAKE_Applications_Module/1_Project_Architecture.md b/docs/3_Developer_Guides/5_Using_CMAKE_Applications_Module/1_Project_Architecture.md deleted file mode 100644 index 0602ea1..0000000 --- a/docs/3_Developer_Guides/5_Using_CMAKE_Applications_Module/1_Project_Architecture.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: Project Architecture ---- - -The following tree structure represents a typical CMake project -directory structure: - -```tree -<project-root-path> -| -├── CMakeLists.txt -│ -├── autobuild/ -│ ├── agl -│ │ └── autobuild -│ ├── linux -│ │ └── autobuild -│ └── windows -│ └── autobuild -├── conf.d/ -│ ├── packaging/ -│ │ ├── rpm -│ │ │ └── package.spec -│ │ └── deb -│ │ ├── package.dsc -│ │ ├── debian.package.install -│ │ ├── debian.changelog -│ │ ├── debian.compat -│ │ ├── debian.control -│ │ └── debian.rules -│ ├── cmake -│ │ ├── 00-debian-osconfig.cmake -│ │ ├── 00-suse-osconfig.cmake -│ │ ├── 01-default-osconfig.cmake -│ │ └── config.cmake -│ └── wgt -│ ├── icon.png -│ └── config.xml.in -├── <target> -│ └── <files> -├── <target> -│ └── <file> -└── <target> - └── <files> -``` - -| File or Directory | Parent | Description | -|----|----|----| -| *root_path* | n/a | CMake project root path. Holds the master CMakeLists.txt file and all general project files. -| CMakeLists.txt | The master CMakeLists.txt file. -| autobuild/ | *root_path* | Scripts generated from app-templates to build packages the same way for differents platforms. -| conf.d/ | *root_path* | Holds needed files to build, install, debug, and package an AGL application project. -| packaging/ | conf.d/ | Contains output files used to build packages. -| cmake/ | conf.d/ | Minimally contains the config.cmake file, which is modified from the sample provided in the app-templates submodule. -| 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. -| *target* | *root_path* | A target to build, which is typically a library or executable. - -When building projects using CMake, the build process automatically detects -the `CMakeLists.txt` and `*.cmake` files. -To help with this process, the `PROJECT_SRC_DIR_PATTERN` variable -is used for recursive pattern searching from the CMake project's -*root_path* downward. -Each sub-folder below *root_path* in the project is searched and included -during compilation. -The directories matching the pattern `PROJECT_SRC_DIR_PATTERN` variable -are scanned. - -**NOTE:** The `PROJECT_SRC_DIR_PATTERN` variable defaults to "*". - -When the `CMakeLists.txt` file is found, the directory in which it is found -is automatically added to the CMake project. - -Similarly, when a file whose extension is `.cmake` is found, the directory in -which that file resides is also added to the CMake project.
\ No newline at end of file |