Deleted TDF documentation (don't have the capacity to maintain it ATM)

src/DebugToolDrivers/Microchip/Protocols/EDBG/AVR/EdbgAvr8Interface.cpp

@@ -1048,10 +1048,7 @@ namespace DebugToolDrivers::Microchip::Protocols::Edbg::Avr
          * the program memory base address (DEVICE_UPDI_PROGMEM_BASE_ADDR_MSB).
          *
          * The additional DEVICE_UPDI_PROGMEM_BASE_ADDR_MSB field is only one byte in size, so it brings the total
-         * capacity for the program memory base address to three bytes. Because of this, we ensure that all TDFs,
-         * for targets that support UPDI, specify an address that does not exceed the maximum value of a 24 bit
-         * unsigned integer. This is done in our TDF validation script (see src/Targets/TargetDescription/README.md
-         * for more).
+         * capacity for the program memory base address to 24 bits.
          */
         Logger::debug("Setting UPDI_PROGMEM_BASE_ADDR AVR8 device parameter");
         this->setParameter(

src/Targets/TargetDescription/README.md

@@ -1,61 +0,0 @@
-## Target description files
-
-A target description file (TDF) is an XML file that describes a particular target. All targets that are supported by
-Bloom will have an associated TDF in Bloom's codebase. They can be found in `src/Targets/TargetDescriptionFiles`.
-
-The data held by TDFs is fundamental to Bloom's operation. The following is an incomplete list of the data contained 
-within Bloom's TDFs:
-
-- Memory address spaces, segments and sections
-- Peripherals register groups, registers and signals
-- Debug interface parameters
-- Target signatures
-- Package variant descriptions
-- Package pinouts
-
-TDFs are distributed with Bloom. They are copied to the build directory
-(`${CMAKE_BINARY_DIR}/resources/TargetDescriptionFiles/`) at build time and included in the distributed packages (DEB,
-RPM, etc).
-
-Upon copying the TDFs, we also generate a JSON mapping of AVR8 target IDs to TDF file paths. This
-mapping is also distributed with Bloom and can be found in the `${CMAKE_BINARY_DIR}/resources/TargetDescriptionFiles/AVR`
-directory, with the name `Mapping.json`. The mapping is used by Bloom, at runtime, to resolve the appropriate TDF from
-an AVR8 target signature. The TDF file paths in the mapping are relative to Bloom's resource directory.
-See the [`Avr8::Avr8(...)`](../../Targets/Microchip/AVR8/Avr8.cpp) constructor for more.
-See `build/scripts/Avr8TargetDescriptionFiles.php` for the script that performs the copying and generation of the JSON
-mapping.
-
-### TDF format
-
-AVR8 TDFs were initially taken from the Microchip Packs Repository (https://packs.download.microchip.com/). Some
-changes were made to the format, to better suit Bloom's requirements.
-
-TODO: Explain the TDF format. For now, developers can gain an understanding of the format by viewing a TDF.
-
-### TDF parsing
-
-The `src/Targets/TargetDescription/` directory contains the necessary code and data structures to parse
-and represent generic TDFs, with the `Targets::TargetDescription::TargetDescriptionFile` class being the entry
-point.
-
-#### Extending the TargetDescriptionFile class for TDFs with formats that are specific to certain target families and/orarchitectures
-
-AVR8 TDFs describe certain constructs in a way that **may** not be employed by other target families. For example,
-AVR8 PORT registers are described in a `<module>` node of the TDF. This method is currently considered to be specific
-to AVR8 TDFs. For that reason, we extend the `Targets::TargetDescription::TargetDescriptionFile` class to better
-represent TDFs for particular target families or architectures. For AVR8 targets, we use the
-`Targets::Microchip::Avr8::TargetDescription::TargetDescriptionFile` class to represent AVR8 TDFs.
-
-It would be good to keep in mind that as and when support for other target families and architectures is implemented,
-we may use the constructs that were initially specific to AVR8 TDFs, in other TDFs. In this case, those constructs will
-likely be moved into the generic `Targets::TargetDescription::TargetDescriptionFile` class.
-
-### TDF validation
-
-In order to ensure that every TDF in Bloom's codebase is in the correct format, and meets the minimum requirements to be
-of use to Bloom, we perform validation on each TDF at build time, just before creating the mapping file. If even one
-TDF fails validation, the build is aborted. This validation takes place in the
-`build/scripts/Avr8TargetDescriptionFiles.php` script.
-
-There is also a separate script for AVR8 TDF validation, for developers to invoke manually, outside of builds,
-when needed: `build/scripts/ValidateAvr8TargetDescriptionFiles.php`. This script will only perform TDF validation.

src/Targets/TargetDescription/TargetDescriptionFile.hpp

@@ -53,11 +53,7 @@ namespace Targets::TargetDescription
      * to be shipped with the Bloom binary.
      *
      * This class may be extended to further reflect a TDF that is specific to a particular target, target architecture
-     * or target family. For example, the Targets::Microchip::Avr8::TargetDescriptionFile class inherits from this
-     * class, to represent TDFs for AVR8 targets. The derived class provides access to additional data that is only
-     * found in AVR8 TDFs (such as AVR target signature, AVR Family, etc).
-     *
-     * For more information of TDFs, see src/Targets/TargetDescription/README.md
+     * or target family. For example, see the Targets::Microchip::Avr8::TargetDescriptionFile class.
      */
     class TargetDescriptionFile
     {