Skip to content

Commit

Permalink
Update release checklist and some minor fixes to the layout of the do…
Browse files Browse the repository at this point in the history
…cument (modelica#184)

Co-authored-by: Benedikt Menne <[email protected]>
  • Loading branch information
bmenne-dspace and Benedikt Menne authored Jun 26, 2024
1 parent 468127f commit 687bdd6
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
5 changes: 3 additions & 2 deletions Release Checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,14 @@ The following checklist indicates which points must be taken into account when c

* [ ] **Document Version:** The `revnumber` and `revdate` fields of the `index.adoc` (see https://github.com/modelica/fmi-ls-bus/blob/main/docs/index.adoc) file needs to be updated accordingly to the specified release version.
* [ ] **Manifest File Example:** The FMI-LS-BUS manifest file example version shall be updated to the specified release version (see https://github.com/modelica/fmi-ls-bus/blob/main/docs/examples/fmi_ls_bus_manifest_example.xml)
* [ ] **Manifest Version:** Update fmi-ls-version of the chapter Layered Standard Manifest File to the respective release version.
* [ ] **MIME Types** Adaptation of the MIME Types (version part), if relevant changes have occurred (see https://modelica.github.io/fmi-ls-bus/main/#low-cut-mime-types).
An update is necessary if the operations has changed within the new target release.
* [ ] **Terminal File Examples:** The FMI-LS-BUS terminal file example MIME Type versions shall be updated corresponding to the specified release (see https://github.com/modelica/fmi-ls-bus/blob/main/docs/examples/) if required.
* [ ] **Remove unsupported Bus Types:** All unsupported buses of the respective version (see https://github.com/modelica/fmi-ls-bus/milestones) must be removed before creating the respective release.
* [ ] **Remove unsupported Bus Types:** All unsupported buses and MIME Types (see MIME Types chapter) of the respective version (see https://github.com/modelica/fmi-ls-bus/milestones) must be removed before creating the respective release.
The removal takes place on the created side branch.
* [ ] **Milestones:** Can milestones (see https://github.com/modelica/fmi-ls-bus/milestones) be closed by the generated release? If so, close this on GitHub.
* [ ] **Copyright Date:** Checking and adjusting the copyright date of the FMI-LS-BUS document and corresponding header files (see https://github.com/modelica/fmi-ls-bus/tree/main/headers); if necessary.
* [ ] **Roadmap:** If the release to be created relates to a milestone within the roadmap, the roadmap (`roadmap.drawio`) must be updated accordingly.
After this the `roadmap.svg` file must then also be regenerated.
* [ ] **FMI LS BUS Implementer's Guide:** Update demos of FMI LS BUS Implementer's Guide (see https://github.com/modelica/fmi-guides/tree/main/ls-bus-guide/demos) if necessary.
* [ ] **FMI LS BUS Implementer's Guide:** Update demo FMUs (modelDescription.xml, fmi-ls-manifest.xml, PackFMU.py) of FMI LS BUS Implementer's Guide (see https://github.com/modelica/fmi-guides/tree/main/ls-bus-guide/demos) if necessary.
2 changes: 1 addition & 1 deletion docs/4_4_1_can.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -634,7 +634,7 @@ _A simple Network FMU might also choose to treat Bus Error or Arbitration operat
Start: "false"
----

This structural parameter is mandatory for Network FMUs.
This structural parameter is mandatory for Network FMUs only.
A Bus Simulation (FMU) does not require this structural parameter.

===== Configuration of Bus Simulation [[low-cut-can-configuration-of-bus-simulation]]
Expand Down
2 changes: 1 addition & 1 deletion docs/4____network_abstraction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ The following table lists the MIME types to use for the Tx/Rx data variables wit

.Overview of the available MIME types for the supported several bus types.
[#table-mime-types]
[cols="4,5",options="header"]
[cols="4,3",options="header"]
|====
|MIME type
|Description
Expand Down

0 comments on commit 687bdd6

Please sign in to comment.