Fix: No build error on input files checked

[apps/app-templates.git] / README.md

diff --git a/README.md b/README.md
index 94aa6be..bf3aea5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -26,9 +26,9 @@ To use these templates files on your project just install the reference files us
 **git submodule** then use `config.cmake` file to configure your project specificities :
 
 ```bash
 **git submodule** then use `config.cmake` file to configure your project specificities :
 
 ```bash

-git submodule add https://gerrit.automotivelinux.org/gerrit/apps/app-templatesconf.d/app-templates conf.d/app-templates
+git submodule add https://gerrit.automotivelinux.org/gerrit/p/apps/app-templates.git conf.d/app-templates

 mkdir conf.d/cmake
 mkdir conf.d/cmake

-cp conf.d/app-templates/cmake/config.cmake.sample conf.d/cmake/config.cmake
+cp conf.d/app-templates/samples.d/config.cmake.sample conf.d/cmake/config.cmake

 ```
 
 Edit the copied config.cmake file to fit your needs.
 ```
 
 Edit the copied config.cmake file to fit your needs.


@@ -39,7 +39,7 @@ An example is available in **app-templates** submodule that you can copy and
 use:
 
 ```bash
 use:
 
 ```bash

-cp conf.d/app-templates/cmake/CMakeLists.txt CMakeLists.txt
+cp conf.d/app-templates/samples.d/CMakeLists.txt.sample CMakeLists.txt

 ```
 
 ### Create your CMake targets
 ```
 
 ### Create your CMake targets


@@ -48,7 +48,7 @@ For each target part of your project, you need to use ***PROJECT_TARGET_ADD***
 to include this target to your project.
 
 Using it, make available the cmake variable ***TARGET_NAME*** until the next
 to include this target to your project.
 
 Using it, make available the cmake variable ***TARGET_NAME*** until the next

-***PROJECT_TARGET_ADD*** is invoked with a new target name. 
+***PROJECT_TARGET_ADD*** is invoked with a new target name.

 
 So, typical usage defining a target is:
 
 
 So, typical usage defining a target is:
 


@@ -59,8 +59,6 @@ add_executable/add_library(${TARGET_NAME}.... --> defining your target sources
 
 SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES.... --> fit target properties
 for macros usage
 
 SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES.... --> fit target properties
 for macros usage

-
-INSTALL(TARGETS ${TARGET_NAME}....

 ```
 
 ### Targets PROPERTIES
 ```
 
 ### Targets PROPERTIES


@@ -74,20 +72,35 @@ widget package with the property **LABELS**:
 Choose between:
 
 - **BINDING**: Shared library that be loaded by the AGL Application Framework
 Choose between:
 
 - **BINDING**: Shared library that be loaded by the AGL Application Framework

-- **HTDOCS**: Root directory of a web app
-- **DATA**: Resources used by your application
+- **BINDINGV2**: Shared library that be loaded by the AGL Application Framework.
+ This has to be accompagnied with a JSON file named like the *${OUTPUT_NAME}-apidef* of
+ the target that describe the API with OpenAPI syntax (e.g: *mybinding-apidef*).
+ Or you can choose the name by setting the *CACHE* cmake variable *OPENAPI_DEF*
+ (***CAUTION***: setting a CACHE variable is needed, or set a normal variable
+ with the *PARENT_SCOPE* option to make it visible for the parent scope
+ where the target is defined) JSON file will be used to generate header file
+ using `afb-genskel` tool.
+- **HTDOCS**: Root directory of a web app. This target has to build its
+ directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}
+- **DATA**: Resources used by your application. This target has to build its
+ directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}

 - **EXECUTABLE**: Entry point of your application executed by the AGL
  Application Framework
 
 - **EXECUTABLE**: Entry point of your application executed by the AGL
  Application Framework
 

+> **TIP** you should use the prefix _afb-_ with your **BINDING* targets which
+> stand for **Application Framework Binding**.
+

 ```cmake
 SET_TARGET_PROPERTIES(${TARGET_NAME}
        PREFIX "afb-"
        LABELS "BINDING"
 ```cmake
 SET_TARGET_PROPERTIES(${TARGET_NAME}
        PREFIX "afb-"
        LABELS "BINDING"

-       OUTPUT_NAME "file_output_name")
+       OUTPUT_NAME "file_output_name"
+)

 ```
 
 ```
 

-> **TIP** you should use the prefix _afb-_ with your **BINDING* targets which
-> stand for **Application Framework Binding**.
+> **NOTE**: You doesn't need to specify an **INSTALL** command for these
+> targets. This is already handle by template and will be installed in the
+> following path : **${CMAKE_INSTALL_PREFIX}/${PROJECT_NAME}**

 
 ## More details: Typical project architecture
 
 
 ## More details: Typical project architecture
 


@@ -106,24 +119,34 @@ A typical project architecture would be :
 │   │       └── autobuild
 │   ├── app-templates/
 │   │   ├── README.md
 │   │       └── autobuild
 │   ├── app-templates/
 │   │   ├── README.md

-│   │   ├── autobuild/
-│   │   │   ├── agl
-│   │   │   │   └── autobuild.in
-│   │   │   ├── linux
-│   │   │   │   └── autobuild.in
-│   │   │   └── windows
-│   │   │       └── autobuild.in

 │   │   ├── cmake/
 │   │   ├── cmake/

-│   │   │   ├── config.cmake.sample

 │   │   │   ├── export.map
 │   │   │   └── macros.cmake
 │   │   │   ├── export.map
 │   │   │   └── macros.cmake

-│   │   ├── deb/
-│   │   │   └── config.deb.in
-│   │   ├── rpm/
-│   │   │   └── config.spec.in
+│   │   ├── 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/
 │   │   └── wgt/

-│   │       ├── config.xml.in
-│   │       ├── config.xml.in.sample

 │   │       ├── icon-default.png
 │   │       ├── icon-html5.png
 │   │       ├── icon-native.png
 │   │       ├── icon-default.png
 │   │       ├── icon-html5.png
 │   │       ├── icon-native.png


@@ -215,11 +238,24 @@ application, macros make the difference using ***LABELS*** property.
 Choose between:
 
 - **BINDING**: Shared library that be loaded by the AGL Application Framework
 Choose between:
 
 - **BINDING**: Shared library that be loaded by the AGL Application Framework

-- **HTDOCS**: Root directory of a web app
-- **DATA**: Resources used by your application
+- **BINDINGV2**: Shared library that be loaded by the AGL Application Framework.
+ This has to be accompagnied with a JSON file named like the *${OUTPUT_NAME}-apidef* of
+ the target that describe the API with OpenAPI syntax (e.g: *mybinding-apidef*).
+ Or you can choose the name by setting the *CACHE* cmake variable *OPENAPI_DEF*
+ (***CAUTION***: setting a CACHE variable is needed, or set a normal variable
+ with the *PARENT_SCOPE* option to make it visible for the parent scope
+ where the target is defined) JSON file will be used to generate header file
+ using `afb-genskel` tool.
+- **HTDOCS**: Root directory of a web app. This target has to build its
+ directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}
+- **DATA**: Resources used by your application. This target has to build its
+ directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}

 - **EXECUTABLE**: Entry point of your application executed by the AGL
  Application Framework
 
 - **EXECUTABLE**: Entry point of your application executed by the AGL
  Application Framework
 

+> **TIP** you should use the prefix _afb-_ with your **BINDING* targets which
+> stand for **Application Framework Binding**.
+

 Example:
 
 ```cmake
 Example:
 
 ```cmake


@@ -229,13 +265,9 @@ SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES
        )
 ```
 
        )
 ```
 

-If your target output is not named as the ***TARGET_NAME***, you need to specify
-***OUTPUT_NAME*** property that will be used by the ***populate_widget*** macro.
-
-Use the ***populate_widget*** macro as latest statement of your target
-definition. Then at the end of your project definition you should use the macro
-***build_widget*** that make an archive from the populated widget tree using the
-`wgtpkg-pack` Application Framework tools.
+> **NOTE**: You doesn't need to specify an **INSTALL** command for these
+> targets. This is already handle by template and will be installed in the
+> following path : **${CMAKE_INSTALL_PREFIX}/${PROJECT_NAME}**

 
 ## Macro reference
 
 
 ## Macro reference
 


@@ -280,6 +312,8 @@ project_subdirs_add("[0-9]-*")
 
 ### Including additionnals cmake files
 
 
 ### Including additionnals cmake files
 

+#### Machine and system custom cmake files
+

 Advanced tuning is possible using addionnals cmake files that are included
 automatically from some specifics locations. They are included in that order:
 
 Advanced tuning is possible using addionnals cmake files that are included
 automatically from some specifics locations. They are included in that order:
 


@@ -287,8 +321,13 @@ automatically from some specifics locations. They are included in that order:
 - Home CMake files located in _$HOME/.config/app-templates/cmake.d_
 - System CMake files located in _/etc/app-templates/cmake.d_
 
 - Home CMake files located in _$HOME/.config/app-templates/cmake.d_
 - System CMake files located in _/etc/app-templates/cmake.d_
 

-CMake files has to be named using the following convention: `XX-***.cmake`,
-where `XX` are numbers, `***` file name (ie. `99-my_customs.cmake`).
+CMake files has to be named using the following convention: `XX-common*.cmake`
+or `XX-${PROJECT_NAME}*.cmake`, where `XX` are numbers, `*` file name
+(ie. `99-common-my_customs.cmake`).
+
+> **NOTE** You need to specify after numbers that indicate include order, to
+which project that file applies, if it applies to all project then use keyword
+`common`.

 
 So, saying that you should be aware that every normal cmake variables used at
 project level could be overwrited by home or system located cmake files if
 
 So, saying that you should be aware that every normal cmake variables used at
 project level could be overwrited by home or system located cmake files if


@@ -301,6 +340,28 @@ Example:
 set(VARIABLE_NAME 'value string random' CACHE STRING 'docstring')
 ```
 
 set(VARIABLE_NAME 'value string random' CACHE STRING 'docstring')
 ```
 

+#### OS custom cmake files
+
+This is meant to personalize the project depending on the OS your are using.
+At the end of config.cmake, common.cmake will include lot of cmake file to
+customize project build depending on your plateform. It will detect your OS
+deducing it from file _/etc/os-release_ now as default in almost all Linux
+distribution.
+
+So you can use the value of field **ID_LIKE** or **ID** if the
+first one doesn't exists and add a cmake file for that distribution in your
+_conf.d/cmake/_ directory or relatively to your _app-templates_ submodule path
+_app-templates/../cmake/_
+
+Those files has to be named use the following scheme _XX-${OSRELEASE}*.cmake_
+where _XX_ are numbers, ${OSRELEASE} the **ID_LIKE** or **ID** field from
+_/etc/os-release_ file. You can also define default OS configuration file
+to use as fallback is none specific OS configuration is available using the
+scheme _XX-default*.cmake_. Then is you need by example a module that isn't
+named the same in one distro only, you only has to define a specific file to
+handle that case then for all the other case put the configuration in the
+default file.
+

 ### Include customs templated scripts
 
 As well as for additionnals cmake files you can include your own templated
 ### Include customs templated scripts
 
 As well as for additionnals cmake files you can include your own templated