summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2018-12-12 10:39:31 +0100
committerRomain Forlot <romain.forlot@iot.bzh>2018-12-14 09:15:07 +0000
commitc631646116197507f59008bc4a4560c74756b342 (patch)
tree04e9f003e15837a43d27ee4e04d4ca7aeefc3583 /src
parentc815f74207220e5e571fece7cbad00b7a39ae8c9 (diff)
Install docs and sample files in a separate dir
Separate the samples files to be installed in the system doc dir which is: - /usr/share/doc Updating the documentation according to the new path to samples. Change-Id: Ib1958fb87d517ad84abddf3ec71102f7ecf877f5 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'src')
-rw-r--r--src/samples.d/CMakeLists.txt.sample21
-rw-r--r--src/samples.d/config.cmake.sample205
-rw-r--r--src/samples.d/config.xml.in.sample142
-rw-r--r--src/samples.d/xds-config.env.sample10
4 files changed, 0 insertions, 378 deletions
diff --git a/src/samples.d/CMakeLists.txt.sample b/src/samples.d/CMakeLists.txt.sample
deleted file mode 100644
index b485097..0000000
--- a/src/samples.d/CMakeLists.txt.sample
+++ /dev/null
@@ -1,21 +0,0 @@
-###########################################################################
-# Copyright 2015, 2016, 2017 IoT.bzh
-#
-# author: Romain Forlot <romain.forlot@iot.bzh>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-###########################################################################
-
-CMAKE_MINIMUM_REQUIRED(VERSION 3.3)
-
-include(${CMAKE_CURRENT_SOURCE_DIR}/conf.d/cmake/config.cmake)
diff --git a/src/samples.d/config.cmake.sample b/src/samples.d/config.cmake.sample
deleted file mode 100644
index 7f58d07..0000000
--- a/src/samples.d/config.cmake.sample
+++ /dev/null
@@ -1,205 +0,0 @@
-###########################################################################
-# Copyright 2015, 2016, 2017 IoT.bzh
-#
-# author: Fulup Ar Foll <fulup@iot.bzh>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-###########################################################################
-
-# Project Info
-# ------------------
-set(PROJECT_NAME example)
-set(API_NAME api-test)
-set(PROJECT_PRETTY_NAME "Example")
-set(PROJECT_DESCRIPTION "AGL application example")
-set(PROJECT_URL "https://gerrit.automotivelinux.org/gerrit/apps/cmake-apps-module")
-set(PROJECT_ICON "icon.png")
-set(PROJECT_AUTHOR "Last Name, First Name")
-set(PROJECT_AUTHOR_MAIL "example.man@bigouden.bzh")
-set(PROJECT_LICENSE "APL2.0")
-set(PROJECT_LANGUAGES "C")
-
-# Which directories inspect to find CMakeLists.txt target files
-# set(PROJECT_SRC_DIR_PATTERN "*")
-
-# Where are stored the project configuration files
-# relative to the root project directory
-set(PROJECT_CMAKE_CONF_DIR "conf.d")
-
-# Compilation Mode (DEBUG, RELEASE, COVERAGE or PROFILING)
-# ----------------------------------
-#set(BUILD_TYPE "DEBUG")
-#set(USE_EFENCE 1)
-
-# Kernel selection if needed. You can choose between a
-# mandatory version to impose a minimal version.
-# Or check Kernel minimal version and just print a Warning
-# about missing features and define a preprocessor variable
-# to be used as preprocessor condition in code to disable
-# incompatibles features. Preprocessor define is named
-# KERNEL_MINIMAL_VERSION_OK.
-#
-# NOTE*** FOR NOW IT CHECKS KERNEL Yocto environment and
-# Yocto SDK Kernel version.
-# -----------------------------------------------
-#set (kernel_mandatory_version 4.8)
-#set (kernel_minimal_version 4.8)
-
-# Compiler selection if needed. Impose a minimal version.
-# -----------------------------------------------
-set (gcc_minimal_version 4.9)
-
-# PKG_CONFIG required packages
-# -----------------------------
-set (PKG_REQUIRED_LIST
- json-c
- afb-daemon
-)
-
-# You can also consider to include libsystemd
-# -----------------------------------
-#list (APPEND PKG_REQUIRED_LIST libsystemd>=222)
-
-# Prefix path where will be installed the files
-# Default: /usr/local (need root permission to write in)
-# ------------------------------------------------------
-#set(INSTALL_PREFIX /opt/AGL CACHE PATH "INSTALL PREFIX PATH")
-
-# Customize link option
-# -----------------------------
-#list(APPEND link_libraries -an-option)
-
-# Compilation options definition
-# Use CMake generator expressions to specify only for a specific language
-# Values are prefilled with default options that is currently used.
-# Either separate options with ";", or each options must be quoted separately
-# DO NOT PUT ALL OPTION QUOTED AT ONCE , COMPILATION COULD FAILED !
-# ----------------------------------------------------------------------------
-#set(COMPILE_OPTIONS
-# -Wall
-# -Wextra
-# -Wconversion
-# -Wno-unused-parameter
-# -Wno-sign-compare
-# -Wno-sign-conversion
-# -Werror=maybe-uninitialized
-# -Werror=implicit-function-declaration
-# -ffunction-sections
-# -fdata-sections
-# -fPIC
-# CACHE STRING "Compilation flags")
-#set(C_COMPILE_OPTIONS "" CACHE STRING "Compilation flags for C language.")
-#set(CXX_COMPILE_OPTIONS "" CACHE STRING "Compilation flags for C++ language.")
-#set(PROFILING_COMPILE_OPTIONS
-# -g
-# -O0
-# -pg
-# -Wp,-U_FORTIFY_SOURCE
-# CACHE STRING "Compilation flags for PROFILING build type.")
-#set(DEBUG_COMPILE_OPTIONS
-# -g
-# -ggdb
-# CACHE STRING "Compilation flags for DEBUG build type.")
-#set(COVERAGE_COMPILE_OPTIONS
-# -g
-# -O0
-# --coverage
-# CACHE STRING "Compilation flags for COVERAGE build type.")
-#set(RELEASE_COMPILE_OPTIONS
-# -O2
-# -pipe
-# -D_FORTIFY_SOURCE=2
-# -fstack-protector-strong
-# -Wformat -Wformat-security
-# -Werror=format-security
-# -feliminate-unused-debug-types
-# -Wl,-O1
-# -Wl,--hash-style=gnu
-# -Wl,--as-needed
-# -fstack-protector-strong
-# -Wl,-z,relro,-z,now
-# CACHE STRING "Compilation flags for RELEASE build type.")
-
-# Location for config.xml.in template file.
-#
-# If you keep them commented then it will build with a default minimal widget
-# template which is very simple and it is highly probable that it will not suit
-# to your app.
-# -----------------------------------------
-#set(WIDGET_ICON "conf.d/wgt/${PROJECT_ICON}" CACHE PATH "Path to the widget icon")
-#set(WIDGET_CONFIG_TEMPLATE "${CMAKE_CURRENT_SOURCE_DIR}/conf.d/wgt/config.xml.in" CACHE PATH "Path to widget config file template (config.xml.in)")
-#set(TEST_WIDGET_CONFIG_TEMPLATE "${CMAKE_CURRENT_SOURCE_DIR}/conf.d/wgt/test-config.xml.in" CACHE PATH "Path to the test widget config file template (test-config.xml.in)")
-
-# Mandatory widget Mimetype specification of the main unit
-# --------------------------------------------------------------------------
-# Choose between :
-#- text/html : HTML application,
-# content.src designates the home page of the application
-#
-#- application/vnd.agl.native : AGL compatible native,
-# content.src designates the relative path of the binary.
-#
-# - application/vnd.agl.service: AGL service, content.src is not used.
-#
-#- ***application/x-executable***: Native application,
-# content.src designates the relative path of the binary.
-# For such application, only security setup is made.
-#
-set(WIDGET_TYPE MimeType_Not_Set)
-
-# Mandatory Widget entry point file of the main unit
-# --------------------------------------------------------------
-# This is the file that will be executed, loaded,
-# at launch time by the application framework.
-#
-set(WIDGET_ENTRY_POINT EntryPoint_Path_Not_Set)
-
-# Optional dependencies order
-# ---------------------------
-#set(EXTRA_DEPENDENCIES_ORDER)
-
-# Optional Extra global include path
-# -----------------------------------
-#set(EXTRA_INCLUDE_DIRS)
-
-# Optional extra libraries
-# -------------------------
-#set(EXTRA_LINK_LIBRARIES)
-
-# Optional force binding Linking flag
-# ------------------------------------
-# set(BINDINGS_LINK_FLAG LinkOptions )
-
-# Optional force package prefix generation, like widget
-# -----------------------------------------------------
-# set(PKG_PREFIX DestinationPath)
-
-# Optional Application Framework security token
-# and port use for remote debugging.
-#------------------------------------------------------------
-set(AFB_TOKEN "" CACHE PATH "Default binder security token")
-set(AFB_REMPORT "1234" CACHE PATH "Default binder listening port")
-
-# Print a helper message when every thing is finished
-# ----------------------------------------------------
-set(CLOSING_MESSAGE "Typical binding launch: cd ${CMAKE_BINARY_DIR}/package \\&\\& afb-daemon --port=${AFB_REMPORT} --workdir=. --ldpaths=lib --roothttp=htdocs --token=\"${AFB_TOKEN}\" --tracereq=common --verbose")
-set(PACKAGE_MESSAGE "Install widget file using in the target : afm-util install ${PROJECT_NAME}.wgt")
-
-# Optional schema validator about now only XML, LUA and JSON
-# are supported
-#------------------------------------------------------------
-#set(LUA_CHECKER "luac" "-p" CACHE STRING "LUA compiler")
-#set(XML_CHECKER "xmllint" CACHE STRING "XML linter")
-#set(JSON_CHECKER "json_verify" CACHE STRING "JSON linter")
-
-include(CMakeAfbTemplates)
diff --git a/src/samples.d/config.xml.in.sample b/src/samples.d/config.xml.in.sample
deleted file mode 100644
index b93f3d9..0000000
--- a/src/samples.d/config.xml.in.sample
+++ /dev/null
@@ -1,142 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<widget xmlns="http://www.w3.org/ns/widgets" id="@PROJECT_NAME@" version="@PROJECT_VERSION@">
- <name>@PROJECT_NAME@</name>
- <icon src="@PROJECT_ICON@"/>
- <content src="@WIDGET_ENTRY_POINT@" type="@WIDGET_TYPE@"/>
- <description>@PROJECT_DESCRIPTION@</description>
- <author>@PROJECT_AUTHOR@ &lt;@PROJECT_AUTHOR_MAIL@&gt;</author>
- <license>@PROJECT_LICENSE@</license>
-
-<!-- Feature : required-api ------------------------------------------------------
-#### param name="#target" OPTIONAL
-
-Declares the name of the unit requiring the listed apis.
-Only one instance of the param "#target" is allowed.
-When there is not instance of this param, it behave as if
-the target main was specified.
-
-#### param name=[required api name]
-
-The name is the name of the required API.
-The value describes how to connect to the required api.
-It is either:
-
- - local: The binding is a local shared object.
- In that case, the name is the relative path of the
- shared object to be loaded.
- - auto: The framework set automatically the kind of
- the connection to the API
- - ws: The framework connect using internal websockets
- - dbus: The framework connect using internal dbus
- - link: The framework connect in memory by dinamically linking
-
-Example:
- <feature name="urn:AGL:widget:required-api">
- <param name="#target" value="low-can" />
- <param name="<a-required-api>" value="auto" />
- <param name="<another-required-api>" value="auto" />
- </feature>
---------------------------------------------------------------------------------->
-
-<!-- Feature : required-permission ------------------------------------------
-
-List of the permissions required by the unit.
-Each required permission must be explicited using a <param> entry.
-
-#### param name="#target" OPTIONAL
-
-Declares the name of the unit requiring the listed permissions.
-Only one instance of the param "#target" is allowed.
-When there is not instance of this param, it behave as if
-the target main was specified.
-
-#### param name=[required permission name]
-
-The value is either:
-- required: the permission is mandatorily needed except if the feature
-isn't required (required="false") and in that case it is optional.
-- optional: the permission is optional
-
-Example:
-<feature name="urn:AGL:widget:required-permission">
- <param name="#target" value="geoloc" />
- <param name="urn:AGL:permission:real-time" value="required" />
- <param name="urn:AGL:permission:syscall:*" value="required" />
-</feature>
---------------------------------------------------------------------------------->
-
-<!-- Feature : provided-unit -------------------------------------------------
-This feature is made for declaring new units
-for the widget. Using this feature, a software publisher
-can provide more than one application in the same widget.
-
-#### param name="#target" REQUIRED
-
-Declares the name of the unit. The default unit, the unit
-of the main of the widget, has the name "main". The value
-given here must be unique within the widget file. It will
-be used in other places of the widget config.xml file to
-designate the unit.
-
-Only one instance of the param "#target" is allowed.
-The value can't be "main".
-
-#### param name="content.type" REQUIRED
-
-The mimetype of the provided unit.
-
-#### param name="content.src"
-
-A path to the file (subject to localisation), this is the entry point
-to that unit.
-
-#### other parameters
-
-The items that can be set for the main unit
-can also be set using the params if needed.
-
- - description
- - name.content
- - name.short
- - ...
-
-Example:
-<feature name="urn:AGL:widget:provided-unit">
- <param name="#target" value="geoloc" />
- <param name="description" value="binding of name geoloc" />
- <param name="content.src" value="index.html" />
- <param name="content.type" value="application/vnd.agl.service" />
-</feature>
---------------------------------------------------------------------------------->
-
-<!-- Feature: provided-api ---------------------------------------------------
-Use this feature for exporting one or more API of a unit
-to other widgets of the platform.
-
-This feature is an important feature of the framework.
-
-#### param name="#target" OPTIONAL
-
-Declares the name of the unit exporting the listed apis.
-Only one instance of the param "#target" is allowed.
-When there is not instance of this param, it behave as if
-the target main was specified.
-
-#### param name=[name of exported api]
-
-The name give the name of the api that is exported.
-
-The value is one of the following values:
-
-- ws: export the api using UNIX websocket
-- dbus: export the API using dbus
-- auto: export the api using the default method(s).
-
-Example:
-<feature name="urn:AGL:widget:provided-api">
- <param name="#target" value="geoloc" />
- <param name="geoloc" value="auto" />
- <param name="moonloc" value="auto" />
-</feature>
---------------------------------------------------------------------------------->
-</widget>
diff --git a/src/samples.d/xds-config.env.sample b/src/samples.d/xds-config.env.sample
deleted file mode 100644
index a4c51b1..0000000
--- a/src/samples.d/xds-config.env.sample
+++ /dev/null
@@ -1,10 +0,0 @@
-XDS_PROJECT_ID=W2EAQBA-HQI75XA_unicens2-binding
-XDS_SDK_ID=poky-agl_aarch64_3.99.1+snapshot
-XDS_SERVER_URL=localhost:8000
-
-DOCKER_TARGET=docker-sdk
-
-RSYNC_TARGET=root@192.168.168.11
-RSYNC_PREFIX=./opt
-PROJECT_DIR=/home/seb/tmp/unicens2-binding
-