Added deprecation notices across four component docs#33
Open
fdesbiens wants to merge 1 commit into
Open
Conversation
threadx-modules/chapter4.adoc:
- txm_module_object_pointer_get: WARNING admonition, link to _extended,
explanation of UINT_MAX overread risk.
filex/chapter4.adoc:
- fx_directory_long_name_get, fx_directory_short_name_get,
fx_media_volume_get, fx_unicode_length_get, fx_unicode_name_get,
fx_unicode_short_name_get: WARNING admonition on each, link to
_extended variant, explanation of fixed-size buffer overrun risk.
usbx/usbx-device-stack-4.adoc:
- ux_device_stack_interface_get: upgraded existing NOTE to a WARNING
with explicit 'Do not use' directive.
guix/chapter-3.adoc:
- Deprecated string API section: added WARNING admonition, explicit
'Do not use in new code' directive, explanation of why the pre-5.6
GX_CHAR* API is unsafe, note about new compile-time warning.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Companion docs update for eclipse-threadx/threadx#562, eclipse-threadx/filex#95, eclipse-threadx/usbx#269, and eclipse-threadx/guix#(pending).
Changes
threadx-modules/chapter4.adoc
txm_module_object_pointer_get: WARNING admonition, link to_extended, explanation of UINT_MAX overread risk.filex/chapter4.adoc
fx_directory_long_name_get,fx_directory_short_name_get,fx_media_volume_get,fx_unicode_length_get,fx_unicode_name_get,fx_unicode_short_name_get): WARNING admonition on each, link to_extendedvariant, explanation of fixed-size buffer overrun risk.usbx/usbx-device-stack-4.adoc
ux_device_stack_interface_get: upgraded existing NOTE to WARNING with explicit 'Do not use' directive.guix/chapter-3.adoc
GX_CHAR*API is unsafe, note about compile-time warning.