adding documentation to user guide on enhanced packed records and arrays

doc/example_architecture/array_register_set/main.adb

@@ -20,7 +20,7 @@ begin
    -- compiler will ensure that the ENTIRE register is read/written
    -- during the following operations.
    if Registers (1).Hw_1_Enabled = Enable and then
-       Registers (4).Hw_2_Enabled = Enable
+      Registers (4).Hw_2_Enabled = Enable
    then
       Registers (7).Threshold := 22;
    end if;

doc/example_architecture/nested_record/env.py

@@ -0,0 +1,8 @@
+import os
+
+this_dir = os.path.dirname(os.path.realpath(__file__))
+# Overwrite the normal build path mechanism and just use
+# this directory as the build path. This prevents any
+# name conflicts we might get from using the regular
+# ".all_path".
+os.environ["EXTRA_BUILD_PATH"] = this_dir + os.sep + ".."

doc/example_architecture/nested_record/nested_record.record.yaml

@@ -0,0 +1,16 @@
+---
+description: This is an example packed record that demonstrates the nesting of other packed records within.
+fields:
+  - name: Simple_Field
+    description: A simple float, we must provide a format
+    type: Short_Float
+    # Required
+    format: F32
+  - name: Nested_Field_1
+    description: This field is of type Example Record, which is itself a packed record definition.
+    type: Example_Record.T
+    # ^ No format specification is necessary, since the
+    # bit representation of a packed record is known
+  - name: Nested_Field_2
+    description: Another field of type Example Record.
+    type: Example_Record.T

doc/example_architecture/record_conversion/main.adb

@@ -2,13 +2,21 @@ with Example_Record;
 
 procedure Main is
    use Example_Record;
-   -- A packed version of the type.
-   Packed_Type : Example_Record.T := (Value_1 => 2, Value_2 => -1, Value_3 => Green, Value_4 => 0.5);
+   -- A packed big-endian version of the type.
+   Packed_Be_Type : Example_Record.T := (Value_1 => 2, Value_2 => -1, Value_3 => Green, Value_4 => 0.5);
+   -- A packed little-endian version of the type.
+   Packed_Le_Type : Example_Record.T_Le;
    -- An unpacked version of the type.
    Unpacked_Type : Example_Record.U;
 begin
-   -- Convert from packed to unpacked:
-   Unpacked_Type := U (Packed_Type);
-   -- Convert from unpacked to packed:
-   Packed_Type := T (Unpacked_Type);
+   -- Convert from big-endian packed to unpacked:
+   Unpacked_Type := Unpack (Packed_Be_Type);
+   -- Convert from unpacked to big-endian packed:
+   Packed_Be_Type := Pack (Unpacked_Type);
+   -- Convert from big-endian to little-endian:
+   Packed_Le_Type := Swap_Endianness (Packed_Be_Type);
+   -- Convert from little-endian to big-endian:
+   Packed_Be_Type := Swap_Endianness (Packed_Le_Type);
+   -- Convert from little-endian packed to unpacked:
+   Unpacked_Type := Unpack (Packed_Le_Type);
 end Main;