Commit 8c3b3066 authored by Maxime Perrotin's avatar Maxime Perrotin
Browse files

Add bus template documentation

parent 03511d00
......@@ -2,7 +2,7 @@ all:
mkdir -p tmp
mkdir -p new-templates
# Extract the latest template tags from any demo project and put them in the new-templates folder
cd ../test/test-cv && kazoo --doc -o ../../doc/tmp --gw -g --glue && mv ../../doc/tmp/Dump/Doc/* ../../doc/new-templates
cd ../test/Demo_Distrib && kazoo --doc -o ../../doc/tmp --gw -g --glue && mv ../../doc/tmp/Dump/Doc/* ../../doc/new-templates
mkdir -p preprocess
cp templates/templates_from_wiki preprocess # copy the previous one
mv templates/templates_from_wiki templates/templates_from_wiki.old # delete the old templates
......
......@@ -7,6 +7,7 @@ templates/skeletons/sub/function.tmplt
templates/skeletons/sub/interface.tmplt
templates/skeletons/sub/makefile.tmplt
templates/concurrency_view/sub/trigger.tmplt
templates/concurrency_view/sub/bus.tmplt
templates/concurrency_view/sub/thread.tmplt
templates/concurrency_view/sub/pi.tmplt
templates/concurrency_view/sub/ri.tmplt
......
......@@ -21,6 +21,9 @@ This template is evaluated only once. The output is saved to the Makefile within
|Instance_Of
|↳ and the instance name or empty string
|-
|Is_Shared_Type
|↳ true if component is an instance of a function stored in the shared types folder
|-
|CP_Files
|List of all context parameters ASN.1 files
|-
......@@ -692,6 +695,28 @@ This file is processed for every node. The result of this file indicates if the
|Is_Distributed
|True if the system contains at least one bus
|}
=== templates/concurrency_view/sub/bus.tmplt ===
This template is parsed for all busses referenced in system.tmplt
{| class="wikitable"
!Parameter name
!Description
|-
|Bus_Name
|Name of the bus
|-
|Classifier
|AADL Classifier for the bus
|-
|Property_Names
|AADL property names (vector tag)
|-
|Property_Values
|AADL property values
|-
|AADL_Package
|AADL package name containing the bus
|}
=== templates/concurrency_view/sub/thread.tmplt ===
This file is processed for every thread in every partition in every node.
{| class="wikitable"
......@@ -1554,6 +1579,9 @@ filesys.tmplt.
|Bus_Classifier
| ↳ Corresponding AADL classifier
|-
|Bus_Properties
| ↳ Corresponding AADL properties (from bus.tmplt)
|-
|Device_Node_Name
|
|-
......
templates/concurrency_view/sub/bus.tmplt
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This template is parsed for all busses referenced in system.tmplt
+-----------------+--------------------------------------+
| Parameter name | Description |
+=================+======================================+
| Bus_Name | Name of the bus |
+-----------------+--------------------------------------+
| Classifier | AADL Classifier for the bus |
+-----------------+--------------------------------------+
| Property_Names | AADL property names (vector tag) |
+-----------------+--------------------------------------+
| Property_Values | AADL property values |
+-----------------+--------------------------------------+
| AADL_Package | AADL package name containing the bus |
+-----------------+--------------------------------------+
......@@ -64,6 +64,9 @@ to the file with name returned by filesys.tmplt.
+-----------------------------------+-----------------------------------+
| Bus_Classifier | ↳ Corresponding AADL classifier |
+-----------------------------------+-----------------------------------+
| Bus_Properties | ↳ Corresponding AADL properties |
| | (from bus.tmplt) |
+-----------------------------------+-----------------------------------+
| Device_Node_Name | |
+-----------------------------------+-----------------------------------+
| Device_Partition | |
......
......@@ -695,6 +695,28 @@ This file is processed for every node. The result of this file indicates if the
|Is_Distributed
|True if the system contains at least one bus
|}
=== templates/concurrency_view/sub/bus.tmplt ===
This template is parsed for all busses referenced in system.tmplt
{| class="wikitable"
!Parameter name
!Description
|-
|Bus_Name
|Name of the bus
|-
|Classifier
|AADL Classifier for the bus
|-
|Property_Names
|AADL property names (vector tag)
|-
|Property_Values
|AADL property values
|-
|AADL_Package
|AADL package name containing the bus
|}
=== templates/concurrency_view/sub/thread.tmplt ===
This file is processed for every thread in every partition in every node.
{| class="wikitable"
......@@ -1557,6 +1579,9 @@ filesys.tmplt.
|Bus_Classifier
| ↳ Corresponding AADL classifier
|-
|Bus_Properties
| ↳ Corresponding AADL properties (from bus.tmplt)
|-
|Device_Node_Name
|
|-
......@@ -1675,4 +1700,4 @@ filesys.tmplt.
|-
|Block_Languages
|DOCUMENTATION MISSING
|}
|}
\ No newline at end of file
......@@ -22,6 +22,10 @@ Makefile within output directory.
| Instance_Of | ↳ and the instance name or empty |
| | string |
+-----------------------------------+-----------------------------------+
| Is_Shared_Type | ↳ true if component is an |
| | instance of a function stored in |
| | the shared types folder |
+-----------------------------------+-----------------------------------+
| CP_Files | List of all context parameters |
| | ASN.1 files |
+-----------------------------------+-----------------------------------+
......@@ -71,5 +75,3 @@ Makefile within output directory.
+-----------------------------------+-----------------------------------+
| Is_FPGA | DOCUMENTATION MISSING |
+-----------------------------------+-----------------------------------+
| Is_Shared_Type | DOCUMENTATION MISSING |
+-----------------------------------+-----------------------------------+
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment