summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2020-06-09Update autobuild script templatesjellyfish_9.99.1jellyfish/9.99.19.99.1Scott Murray1-8/+26
Update autobuild.in files with reworked version with the following changes: - Fixes for building outside of the source tree by over-riding BUILD_DIR* (done by use of new ROOT_DIR variable). - Rules simplified by use of static pattern rules and target specific variables. - package-test rule no longer builds the full widget, only the test widget. This is a behavior change, but seems more in line with developer expectations and avoids wasting time during builds from AGL. - package-{coverage,debug}-test rules removed for lack of utility. - Variable usage switched to parentheses instead of braces to match typical usage in Makefiles in other FOSS projects. The autobuild documentation has also been updated to include the previously added targets and BUILD_DIR* variables, and the description of package-test has been updated for the behavior change mentioned above. Bug-AGL: SPEC-2049, SPEC-3300 Signed-off-by: Scott Murray <scott.murray@konsulko.com> Change-Id: Ifaf0d59b9ee26bde6d27b8968e68f5dc84df548c
2019-11-06docs(using-cmake.md): Remove & refresh expired linkicefish_8.99.1icefish/8.99.18.99.1Li Xiaoming1-2/+1
Bug-AGL: SPEC-2405 Change-Id: Id149d3e648e8cb81ab7b03743bf73a652937b9f9 Signed-off-by: Li Xiaoming <lixm.fnst@cn.fujitsu.com>
2019-08-14Fix document mistakeLi Xiaoming1-1/+1
autobuild clean will remove all the prodcuts defined in Makefile, including autobuild script itself(not inside build folder). Bug-AGL: SPEC-2714 Change-Id: I2d0d47f74a76524dc6335d9a9d027ae793bacda9 Signed-off-by: Li Xiaoming <lixm.fnst@cn.fujitsu.com>
2019-08-01Fix autobuild script pathLi Xiaoming1-1/+1
Bug-AGL: SPEC-2714 Change-Id: I92792739faf83080916db339c428c81e25061e7c Signed-off-by: Li Xiaoming <lixm.fnst@cn.fujitsu.com>
2019-06-11CMake Nav Panel: Changed configuration titleScott Rifenbark1-1/+1
Changed the topic title in the navigation pane from "Configuring CMake" to "Configuring AGL CMake Templates" since the topic is more about configuring AGL-specific CMake templates and not CMake in general. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Change-Id: Ibca59957cd967bca0b8d0570c8774fb9e1903110
2019-06-11CMake project arch: Fixed title to match nav panelScott Rifenbark1-1/+1
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Change-Id: I28d9cdf7ed173d71e19d37ae200652b2e83af240
2019-06-11CMake Configuring: Updated topic title.Scott Rifenbark1-1/+1
Amended to change the title to "Configuring AGL CMake Templates" based on review comments. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Change-Id: I809e83b51829852d4cd2d76494489b5e2d6b89ef Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-06-09CMake Overview: Added TOC links and edits.Scott Rifenbark1-1/+17
I put in a linkable topic list and made sure the topic titles matched what is in the book.yml file. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Change-Id: I32893f8380ec1927513dd44bd8f1e0247a0c39bd
2019-06-09Book manual updates for CMake TemplatesScott Rifenbark1-3/+3
I made some string changes from "CMAKE" to "CMake" for consistency. Also, set the version from "guppy" to "master". Change-Id: I3ee142a4ec541e8776c5a31c396e1435ac4b5dea Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-05-14Fix cmake-apps-module document typo.Li Xiaoming1-3/+3
Bug-AGL: SPEC-2404 Change-Id: I981ebec1e7c36c282e5d3bf327bb5faedd46e877 Signed-off-by: Li Xiaoming <lixm.fnst@cn.fujitsu.com>
2019-04-12CMake: Complete re-write of the CMake topic.Scott Rifenbark1-1/+1
Change-Id: I97c3a450401b87b8419ff00615588c261e6afc25 Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> (cherry picked from commit 7061edf1849de1bb1730df92d23aa52a6793a609)
2019-04-08CMake Topic book: Updated for the new file names.Scott Rifenbark2-10/+12
Change-Id: Ic4883cead2c8fe19fbe3ec3ae5a6db005786561d Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-04-04CMake Section: Complete re-write.Scott Rifenbark14-748/+609
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>
2019-03-26cmake-apps-module: New file names.Scott Rifenbark9-63/+360
Created some new file names based on some re-writing. Also, updated the devguides-book.yml file to reflect the state of things. Change-Id: I6a9a91fe9c2f271493404ab7d63b6d6a8faf586e Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-12-20docs: add yaml bookhalibut_7.90.0halibut/7.90.0guppy_6.99.4guppy_6.99.3guppy/6.99.4guppy/6.99.37.90.06.99.46.99.3Frederic Marec1-0/+22
Bug-AGL: SPEC-1988 Change-Id: I1b0b2d4f0bef6bb14c17303200641578b8bd5687 Signed-off-by: Frederic Marec <frederic.marec@iot.bzh>
2018-12-14Point to SDK sysroot files first instead of nativeRomain Forlot1-0/+10
Point to SDK sysroot files first instead of native installation directories. Bug-AGL: SPEC-1958 Change-Id: I54f4e3dac9951289b245911f82767dbe4c2dd30f Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2018-12-14Install docs and sample files in a separate dirRomain Forlot5-8/+380
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>
2018-11-30Update installation abstract instructionsguppy_6.99.2guppy/6.99.26.99.2Romain Forlot1-9/+74
Make clearer the difference between build environments Yocto, cross compile with an AGL SDK and native. Change-Id: Id09782c8648026420fbfdbbbcf0fd1891edb7b86 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2018-11-30Revert "doc: Improve formatting"Romain Forlot1-7/+3
This reverts commit 60b0f4556fb94cbd6d9bac083f561067a437d98e. Change-Id: Id73104aa7466e6a16ec6a93842718017a2084584 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2018-11-29doc: Improve formattingJosé Bollo1-2/+6
Change-Id: Id252624a59fffe789b93e978ef60eec2fc659055 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2018-11-12Explain why add_subdirectory raise errorJosé Bollo1-0/+11
Change-Id: Id304c589ebe4f1e944377047ca3d462dce80dd7d Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2018-11-12doc: Fix sample of SET_TARGET_PROPERTIESJosé Bollo1-1/+1
Change-Id: Iec703099717e7b9e876db0e8c1ba9c450049d404 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2018-11-07Update docsRomain Forlot5-136/+166
Since migration to CMake module, the doc needs to be be updated to reflect the change and get rid of all git submodule occurrences. Change-Id: If56c50a845d01dafd6b5dcd46cac7cfb2be76e85 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2018-10-15app-templates doc: Changed doc to fit new format.CorentinLGS10-771/+0
-Split book.json in 2. -Deleted unwanted files. Change-Id: Idaa2bc838917cade2b3ff1848e21415acae72aec Signed-off-by: CorentinLGS <corentinlgs@gmail.com>
2018-10-15Update DocsRomain Forlot1-9/+22
Change-Id: If1c1e14233a765058a372fc25a88b21e8824f4d7 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2018-10-15Create a test widgetRomain Forlot2-5/+46
Create a test widget in addition of the normal one when you use any build type except of RELEASE. This widget will only provide the test files (configuration + test + fixtures ...). It joins the test framework binding to your binding or app then you only have to access to your defined test API and launch the tests. The entry point is a bash script which is in charge to launch all tests it finds. Change-Id: I8f4a670f17fd4e4319c53a861074fb5e10b63aad Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2018-10-15Update documentationRomain Forlot2-13/+44
Better description to use BINDINGV2 labels. Adding documentation for macros: - add_input_files - set_openapi_filename Change-Id: I7eb685faf4a5d4f92343d826877066b54b0012f0 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2018-10-15Doesn't set rpath for built target and update docRomain Forlot1-0/+3
Rpath could be set using a target property if needed in the mean time no rpath is used by default. Change-Id: Ia704b00972545ed73dee98ea88e17d0ef08cf014 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2018-10-15Details external library.Romain Forlot2-2/+32
Linting and little typo fixes. Change-Id: I714477b429c9257595ee8eae05ba1ef4901234a2 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2018-10-15Update README and documentationRomain Forlot3-17/+88
Instructions to include external library into a widget Change-Id: Ic5c8c477fdbc1d374f1f88260b51cb9f200d02e1 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2018-10-15Update docRomain Forlot3-18/+34
Change-Id: I942267d9673651db6986177e8d47aa0dbc235e3e Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2018-10-15Update doc and README with latest modificationsRomain Forlot3-12/+33
Change-Id: I7b42fe371b6912de9df42a76781a8886dd804b3d Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2018-10-15Format: Remove spaces at EOLRomain Forlot1-1/+1
Change-Id: If16b9cd45e5955b8ca8049fee1ea97a9d43d5cb7 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2018-10-15Personal files inclusion now by projects.Romain Forlot1-2/+7
Depending on file name you can include some files from your home or system by project or globally Change-Id: I1fef678073977633576a21893065e681b286646c Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2018-10-15Update documentation about propertiesRomain Forlot2-4/+16
Change-Id: Id5f3349889d0b26ebec7e3a90a549b0ceb4fb493 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2018-10-15Be able to choose openAPI definition file name.Romain Forlot1-3/+7
Use a variable OPENAPI_DEF to define the file name else use the default convention ${OUTPUT_NAME}-apidef. Update the docs in consequence. Change-Id: Ibc29d6079d185e47a80dbfe4df5dedd28f7f63c4 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2018-10-15Update README/docs with new LABELS BINDINGV2 infosRomain Forlot1-0/+4
Change-Id: I419c02d9ab5ef785d3103b2e043d4df9fa244a6c Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2018-10-15Update doc & use gitbook to enhance doc generationRomain Forlot20-0/+1169
Change-Id: If42c916f7664ea67b818a21b8f50c66c41e11f89 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>