diff options
author | Sebastien Douheret <sebastien.douheret@iot.bzh> | 2019-06-27 17:55:48 +0200 |
---|---|---|
committer | Sebastien Douheret <sebastien.douheret@iot.bzh> | 2019-06-27 17:55:48 +0200 |
commit | d87906a9406c9739f9fa217b6c1d3e76a4b51fa6 (patch) | |
tree | ef00ea20605e8d7405c8234ccdc603f0c4b916ab /docs/dev_guide/2_project_architecture.md | |
parent | 77cef644f9a3abd582179f4ebfdd090b62ea66a9 (diff) |
Update docs with deprecated messageneedlefish_13.93.0needlefish/13.93.0marlin_12.93.0marlin_12.92.0marlin_12.91.0marlin_12.90.1marlin_12.90.0marlin/12.93.0marlin/12.92.0marlin/12.91.0marlin/12.90.1marlin/12.90.0lamprey_11.92.0lamprey_11.91.0lamprey/11.92.0lamprey/11.91.0koi_10.93.0koi_10.92.0koi_10.91.0koi/10.93.0koi/10.92.0koi/10.91.0jellyfish_9.99.4jellyfish_9.99.3jellyfish_9.99.2jellyfish_9.99.1jellyfish/9.99.4jellyfish/9.99.3jellyfish/9.99.2jellyfish/9.99.1icefish_8.99.5icefish_8.99.4icefish_8.99.3icefish_8.99.2icefish_8.99.1icefish/8.99.5icefish/8.99.4icefish/8.99.3icefish/8.99.2icefish/8.99.1halibut_8.0.6halibut_8.0.5halibut_8.0.4halibut_8.0.3halibut_8.0.2halibut_8.0.1halibut_8.0.0halibut_7.99.3halibut_7.99.2halibut/8.0.6halibut/8.0.5halibut/8.0.4halibut/8.0.3halibut/8.0.2halibut/8.0.1halibut/8.0.0halibut/7.99.3halibut/7.99.29.99.49.99.39.99.29.99.18.99.58.99.48.99.38.99.28.99.18.0.68.0.58.0.48.0.38.0.28.0.18.0.07.99.37.99.213.93.012.93.012.92.012.91.012.90.112.90.011.92.011.91.010.93.010.92.010.91.0halibut
Change-Id: I1e72c255b7714a08a0ec92d504db5d6662f1ae64
Bug-AGL: SPEC-2027
Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
Diffstat (limited to 'docs/dev_guide/2_project_architecture.md')
-rw-r--r-- | docs/dev_guide/2_project_architecture.md | 108 |
1 files changed, 0 insertions, 108 deletions
diff --git a/docs/dev_guide/2_project_architecture.md b/docs/dev_guide/2_project_architecture.md deleted file mode 100644 index 6365539..0000000 --- a/docs/dev_guide/2_project_architecture.md +++ /dev/null @@ -1,108 +0,0 @@ -# Project architecture - -A typical project architecture would be : - -```tree -<project-root-path> -│ -├── conf.d/ -│ ├── autobuild/ -│ │ ├── agl -│ │ │ └── autobuild -│ │ ├── linux -│ │ │ └── autobuild -│ │ └── windows -│ │ └── autobuild -│ ├── app-templates/ -│ │ ├── README.md -│ │ ├── cmake/ -│ │ │ ├── export.map -│ │ │ └── macros.cmake -│ │ ├── samples.d/ -│ │ │ ├── CMakeLists.txt.sample -│ │ │ ├── config.cmake.sample -│ │ │ ├── config.xml.in.sample -│ │ │ └── xds-config.env.sample -│ │ ├── template.d/ -│ │ │ ├── autobuild/ -│ │ │ │ ├── agl -│ │ │ │ │ └── autobuild.in -│ │ │ │ ├── linux -│ │ │ │ │ └── autobuild.in -│ │ │ │ └── windows -│ │ │ │ └── autobuild.in -│ │ │ ├── config.xml.in -│ │ │ ├── deb-config.dsc.in -│ │ │ ├── deb-config.install.in -│ │ │ ├── debian.changelog.in -│ │ │ ├── debian.compat.in -│ │ │ ├── debian.rules.in -│ │ │ ├── gdb-on-target.ini.in -│ │ │ ├── install-wgt-on-target.sh.in -│ │ │ ├── start-on-target.sh.in -│ │ │ ├── rpm-config.spec.in -│ │ │ └── xds-project-target.conf.in -│ │ └── wgt/ -│ │ ├── icon-default.png -│ │ ├── icon-html5.png -│ │ ├── icon-native.png -│ │ ├── icon-qml.png -│ │ └── icon-service.png -│ ├── packaging/ -│ │ ├── config.spec -│ │ └── config.deb -│ ├── cmake -│ │ └── config.cmake -│ └── wgt -│ └── config.xml.in -├── <libs> -├── <target> -│ └── <files> -├── <target> -│ └── <file> -└── <target> - └── <files> -``` - -| # | Parent | Description | -| - | -------| ----------- | -| \<root-path\> | - | Path to your project. Hold master CMakeLists.txt and general files of your projects. | -| conf.d | \<root-path\> | Holds needed files to build, install, debug, package an AGL app project | -| app-templates | conf.d | Git submodule to app-templates AGL repository which provides CMake helpers macros library, and build scripts. config.cmake is a copy of config.cmake.sample configured for the projects. SHOULD NOT BE MODIFIED MANUALLY !| -| autobuild | conf.d | Scripts generated from app-templates to build packages the same way for differents platforms.| -| cmake | conf.d | Contains at least config.cmake file modified from the sample provided in app-templates submodule. | -| wgt | conf.d | Contains at least config.xml.in template file modified from the sample provided in app-templates submodule for the needs of project (See config.xml.in.sample file for more details). | -| packaging | conf.d | Contains output files used to build packages. | -| \<libs\> | \<root-path\> | External dependencies libraries. This isn't to be used to include header file but build and link statically specifics libraries. | Library sources files. Can be a decompressed library archive file or project fork. | -| \<target\> | \<root-path\> | A target to build, typically library, executable, etc. | - -## Manage app-templates submodule - -### Update - -You may have some news bug fixes or features available from app-templates -repository that you want. To update your submodule proceed like the following: - -```bash -git submodule update --remote -git commit -s conf.d/app-templates -``` - -This will update the submodule to the HEAD of master branch repository. Save -the modification by commiting it in your master git project. - -### Checkout submodule to a git tag - -You could just want to update at a specified repository tag or branch or commit -, here are the method to do so: - -```bash -cd conf.d/app-templates -# Choose one of the following depending what you want -git checkout <tag_name> -git checkout --detach <branch_name> -git checkout --detach <commit_id> -# Then commit -cd ../.. -git commit -s conf.d/app-templates -``` |