-
Type:
Bug
-
Resolution: Fixed
-
Priority:
High
-
SITSW-2313
-
-
11.00.00
-
The online version of the Linux SDK User Manual (as well as the offline tarball available for download) needs a revision history / change log as part of the document to keep customers in the loop of any edits/changes.
Currently there is no change history/tracking, making it difficult for a customer to figure out that anything was changed. For example the Yocto build steps part of the Linux SDK v8.6 https://software-dl.ti.com/processor-sdk-linux/esd/AM62X/08_06_00_42/exports/docs/linux/Overview_Building_the_SDK.html#build-steps where changed 3 times in March to fix an issue, but it is not reflected anywhere that this change happened. Similarly, a new section was added (https://software-dl.ti.com/processor-sdk-linux/esd/AM62X/08_06_00_42/exports/docs/devices/AM62X/linux/Release_Specific_Workarounds.html?highlight=workarounds#usb-device-firmware-upgrade-dfu-boot-fix) and also there is no change log highlighting such. If as a customer I looked at/downloaded the documentation 3 weeks ago I would never notice or get this change.
It feels like the current approach of releasing documentation is a regression from previous Wiki-based documentation, which always had a mandatory change log as part of the Wiki system (which also required no effort on the author side).
Fix:
Version tracking enabled in processor-sdk-docs and generated html release pages will show at the footer section on exactly which sha ref the docs are generated based on
Ref: https://github.com/TexasInstruments/processor-sdk-doc/releases/tag/11.00.09.04