Update documentation #716
Update documentation #716
Conversation
erikbosch
added
Scope:Minor
docs-gen/content/rule_set/basics.md
Outdated
| Vehicle.Cabin.Door.Row1.Left.IsLocked | ||
| SomeOtherTree.AnotherBranch.MySignalName |
There was a problem hiding this comment.
Not sure for what is this an example, doesn't it state above every branch need to start with "Vehicle"?
There was a problem hiding this comment.
In the VSS standard catalog the root name is Vehicle, but you may have a different tree using VSS syntax and then you can select whatever root name you want. Like if you use HIM to specify that multiple trees shall be used. I tried to make it more visible by renaming it from SomeBranch to SomeOtherTree. But that is sort of a special case so I am considering just removing this line.
| @@ -57,6 +62,8 @@ The time and date format shall be as shown below, where the sub-second data and | |||
| YYYY-MM-DDTHH:MM:SS.ssssssZ | |||
| ``` | |||
|
|
|||
| VSS also supports the unit `unix-time` that can be used together with datatype `uint32`/`uint64`/`int64`to indicate that the signal value correspond to number of non-leap seconds which have passed since 00:00:00 UTC on Thursday, 1 January 1970. | |||
There was a problem hiding this comment.
Is this relevant here, "unix-time" being a unit (not a datatype), and we are also not explicitly talking about all the other units in the standard catalogue unit file.
There was a problem hiding this comment.
But with that argument we could remove the whole Timestamps section from data_types.md as we do not have any specific "timestamp" datatype. I think it makes sense to somewhere describe the two methods we support for reporting timestamps, but maybe it fits better in the unit section of documentation.
There was a problem hiding this comment.
Will refactor #717 a bit and then we can remove it here
|
MoM: Please review |
docs-gen/content/rule_set/basics.md
Outdated
| * Boolean signals must start with `Is`. | ||
| * Full path of node names must be unique also when using case insensitive comparison. | ||
| It is for example not allowed to have both `Vehicle.Abc` and `Vehicle.ABC` in the standard catalog | ||
| even if that is valid VSS as VSS is case sensitive. |
There was a problem hiding this comment.
Lines 121 to 123 are confusing. Can we shorten it to something like:
Node names are case insensitive for comparison operations, therefore the full path of node names must be unique e.g. Vehicle.Abc and Vehicle.ABC are the same in comparison and therefore the presence of both is prohibited.
Clarifies string/float/double. Reformat recommendatations to state that they also are rules for VSS catalog Remove enum recommendation Fixes COVESA#705 Fixes COVESA#706 Partially solves COVESA#700 Fixes COVESA#662 Signed-off-by: Erik Jaegervall <[email protected]>
|
PR updated to address comments |
erikbosch
removed
the
Status:New
|
MoM: Merge |
Aligning messages to what is stated in documentation after COVESA/vehicle_signal_specification#716 Signed-off-by: Erik Jaegervall <[email protected]>
Aligning messages to what is stated in documentation after COVESA/vehicle_signal_specification#716 Signed-off-by: Erik Jaegervall <[email protected]>
Aligning messages to what is stated in documentation after COVESA/vehicle_signal_specification#716 Signed-off-by: Erik Jaegervall <[email protected]>
Aligning messages to what is stated in documentation after COVESA/vehicle_signal_specification#716 Signed-off-by: Erik Jaegervall <[email protected]>
Proposed follow-up actions if PR accepted.
Vehicle.OBD.PidsA)Vehicle.Cabin.AbcandVehicle.Cabin.ABCMakefileused in CI so that we enforce recommendations for the standard catalog.Fixes #705
Fixes #706
Partially #700 (but more needed to complete it)
Fixes #662
Fixes #280