Skip to content

Commit

Permalink
Removed private and fixed typos
Browse files Browse the repository at this point in the history
- removed private branch, as it's now handled by overlays
- fixed typos.

Signed-off-by: Daniel Wilms <Daniel.DW.Wilms@bmw.de>
  • Loading branch information
danielwilms authored and jdacoello committed Feb 15, 2023
1 parent 14dc4e4 commit 4c9cef3
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 31 deletions.
22 changes: 11 additions & 11 deletions docs-gen/content/rule_set/overlay.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 7

VSS defines the standard catalog for vehicle signals independent of the used protocol and environment.
In order to adopt the specification we realize that certain additions and modifications to the standard catalog are necessary.
**VSS Overlay** are meant to bring you a standardized way of handling those changes.
**VSS Overlays** are meant to bring you a standardized way of handling those changes.

The following features with the intended usage patterns are currently supported:
1. **Adding new nodes:** By adding nodes the standard catalog can be extended with proprietary concepts.
Expand All @@ -21,17 +21,17 @@ Extending the model with richer information is a fundamental feature enabled by
The standard catalogue is specified within COVESA and defines a common view of the major
attributes, sensors and actuators of vehicles. This is used in many different scenarios,
protocols and environments. Additional meta data might be required for data-governance,
-quality or -sources. The instanciation of branches might not fit your vehicle.
-quality or -sources. The instantiation of branches might not fit your vehicle.
Proprietrary signals might be needed for extending the specification for your own use-cases.
Up to now you were on your own in these scenarios. Overlays give you now the chance to change
Up to now you were on your own in these scenarios. Overlays give you the chance to change
and modify the standard catalog in a standardized way.

### How does it work?

Simply said, the tooling takes next to the original specification file, *n* additional
spec files, which overwrite the original information, they contain. Before you start
you should know:
- **Overlay-files have to be by themselves valid specification files.**
Simply said, the tooling accepts, *n* additional spec files, next to the original
specification file, which can overwrite or extend data in the VSS tree defined by
the original specification.Before you start you should know:
- **Overlay-files have to be valid specification files by themselves.**
In practice that means, that the path to a node has to be well defined.
Just to specify the changes of a certain node isn't enough and needs the
nodes, which form the path to the node in question.
Expand Down Expand Up @@ -105,13 +105,13 @@ Vehicle.Cabin.Door.IsOpen:

### Overlays in the standard catalog

With the feature of overlay, we introduced a new folder in the
With the feature of overlays, we introduced a new folder in the
repository called `overlays`. In there you'll find two additional folders:

* `Profiles`: Larger overlays to adapt VSS to a specific vehicle category, like motorbikes.
* `Extensions`: Smaller overlays typically to be applied after applying profiles (if any).
* `profiles`: Larger overlays to adapt VSS to a specific vehicle category, like motorbikes.
* `extensions`: Smaller overlays typically to be applied after applying profiles (if any).

{{% notice warning %}}
**DISCLAIMER:** Use of overlays is a new concept for VSS.
The overlays in those folders shall currently be seen as examples only, and are not part of the official VSS specification.
{{% /notice %}}
{{% /notice %}}
14 changes: 0 additions & 14 deletions spec/Private/Private.vspec

This file was deleted.

6 changes: 0 additions & 6 deletions spec/VehicleSignalSpecification.vspec
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,6 @@ Vehicle:

#include Vehicle/Vehicle.vspec Vehicle

Vehicle.Private:
type: branch
description: Uncontrolled branch where non-public signals can be defined.

#include Private/Private.vspec Vehicle.Private


#
# The power train branch used to host the signals and attributes.
Expand Down

0 comments on commit 4c9cef3

Please sign in to comment.