summaryrefslogtreecommitdiffstats
path: root/docs/dev_guide/3-project-architecture.md
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2019-04-04 16:52:19 -0700
committerScott Rifenbark <srifenbark@gmail.com>2019-04-04 16:53:16 -0700
commit27107400a13c053870b3bb8cbe2379099231ccab (patch)
treef302213f1443874a778b30292cbef7ae166e4f26 /docs/dev_guide/3-project-architecture.md
parent16829a33f77f9d9eda435f5f1c36f36bc33fb267 (diff)
CMake Section: Complete re-write.
Completely re-wrote the section. New file names that do not use the numbers also. Change-Id: I443feb41cf83d760a57179473439e89e7b71f9c5 Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Diffstat (limited to 'docs/dev_guide/3-project-architecture.md')
-rwxr-xr-xdocs/dev_guide/3-project-architecture.md76
1 files changed, 0 insertions, 76 deletions
diff --git a/docs/dev_guide/3-project-architecture.md b/docs/dev_guide/3-project-architecture.md
deleted file mode 100755
index aefaca3..0000000
--- a/docs/dev_guide/3-project-architecture.md
+++ /dev/null
@@ -1,76 +0,0 @@
-# Project architecture
-
-CMake projects follow a typical file hierarchy.
-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/ | confd/ | Contains output files used to build packages.
-| cmake/ | confd/ | Minimally contains the config.cmake file, which is modified from the sample provided in the app-templates submodule.
-| wgt/ | confd/ | 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.
-
-
-