[EXT_SITMPUSW-145] Linux SDK User Manual needs Customer-Accessible Change Log / Revision History Created: 06/Aug/25 Updated: 06/Aug/25 Resolved: 06/Aug/25 |
|
| Status: | Fixed |
| Project: | Sitara MPU & SPMCU SDKs |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Bug | Priority: | High |
| Reporter: | TI User | Assignee: | TI User |
| Resolution: | Fixed | Votes: | 0 |
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Internal ID: | SITSW-2313 |
| Found In Release: | 10.00.00 10.01.00 |
| Fix In Release: | 11.00.00 |
| Affected Platform/Device: | am62xx-sk am62xx-sk-lp am62a-sk am62p-sk am64xx-evm am64xx-sk am335x-evm am335x-hsevm am335x-ice am335x-sk beaglebone-black am437x-idk am437x-sk am43xx-gpevm am43xx-hsevm am654x-hsevm am654x-evm am654x-idk am62a-presil am64xx-presil am61x-sk |
| Description |
|
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: |