Add documentation for delete argument

Signed-off-by: Erik Jaegervall <[email protected]>
COVESA · Aug 1, 2024 · 3f78753 · 3f78753
1 parent 58fa466
commit 3f78753
Showing 1 changed file with 34 additions and 0 deletions.
diff --git a/docs-gen/content/rule_set/overlay.md b/docs-gen/content/rule_set/overlay.md
@@ -10,6 +10,7 @@ In order to adopt the specification we realize that certain additions and modifi
 
 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.
+1. **Deleting nodes:** Deleting nodes not relevant for the vehicle.
 1. **Changing the value of existing metadata:** The standard catalog defines metadata based on what is assumed to be an average vehicle.
 Configurations may differ slightly (e.g. the instantiation of number of available seats), or special situations that require a (limited) modification of existing metadata.
 1. **Adding new key/value pairs as additional metadata:**
@@ -114,6 +115,39 @@ Vehicle.Occupant.Row1.DriverSide.HeadPosition.Yaw:
   unit: mm
 ```
 
+### Deleting nodes
+
+It is possible to delete nodes using the `delete` atrribute.
+You can delete indidvidual signals, branches, instances or a particular signal in a particular instance.
+A few examples are shown below.
+
+```YAML
+# Removing IsChildLockActive for DriverSide on Second Row
+Vehicle.Cabin.Door.Row2.DriverSide.IsChildLockActive:
+  datatype: boolean
+  type: sensor
+  delete: true
+
+# Removing Window for all Door instances
+Vehicle.Cabin.Door.Window:
+  delete: true
+
+# Removing Vehicle.Speed
+Vehicle.Speed:
+  delete: true
+```
+
+When using the `delete` argument vss-tools will print information on nodes removed.
+
+```bash
+INFO     Node Vehicle.Speed will be deleted.    
+INFO     Node Vehicle.Cabin.Door.Row1.DriverSide.Window will be deleted.                                                                            
+INFO     Node Vehicle.Cabin.Door.Row1.PassengerSide.Window will be deleted.                                                                       
+INFO     Node Vehicle.Cabin.Door.Row2.DriverSide.Window will be deleted.                                                                            
+INFO     Node Vehicle.Cabin.Door.Row2.DriverSide.IsChildLockActive will be deleted.                                                                 
+INFO     Node Vehicle.Cabin.Door.Row2.PassengerSide.Window will be deleted. 
+```
+
 ### Overlays in the standard catalog
 
 With the feature of overlays, we introduced a new folder in the