Imagelibrary/rtems
1
0
Fork 1
mirror of https://gitlab.rtems.org/rtems/rtos/rtems.git synced 2025-12-25 13:57:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

cpukit: Correct region documentation notes

Browse Source 
Update the rtems_region_get_information() and
rtems_region_get_information() documentation with various more or less
minor wording fixes:

* "obtain a diagnostic information." ->
  "obtain diagnostic information."

* "This method forms am O(n)" ->
  "This directive performs an O(n)"

* "scan of the free in the region" ->
  "scan of the free blocks in the region"

* "many used blocks and a much smaller number of used blocks" ->
  "many used blocks and a much smaller number of free blocks"

These changes were generated from rtems-central.
This commit is contained in:
Martin Erik Werner
2025-09-03 23:51:15 +02:00
committed by Gedare Bloom
parent 71670c9cb0
commit b19d1c49ed
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
cpukit/include/rtems/rtems/region.h
View File

@@ -634,11 +634,11 @@ rtems_status_code rtems_region_resize_segment(
*
* @par Notes
* @parblock
* This is primarily intended as a mechanism to obtain a diagnostic
* information. This method forms am O(n) scan of the free and an O(n) scan of
* the used blocks in the region to calculate the information provided. Given
* that the execution time is driven by the number of used and free blocks, it
* can take a non-deterministic time to execute.
* This is primarily intended as a mechanism to obtain diagnostic information.
* This directive performs an O(n) scan of the free and an O(n) scan of the
* used blocks in the region to calculate the information provided. Given that
* the execution time is driven by the number of used and free blocks, it can
* take a non-deterministic time to execute.
*
* To get only the free information of the region use
* rtems_region_get_free_information().
@@ -692,12 +692,12 @@ rtems_status_code rtems_region_get_information(
* rtems_region_get_information() directive but does not fill in the used
* information.
*
* This is primarily intended as a mechanism to obtain a diagnostic
* information. This method forms am O(n) scan of the free in the region to
* This is primarily intended as a mechanism to obtain diagnostic information.
* This directive performs an O(n) scan of the free blocks in the region to
* calculate the information provided. Given that the execution time is driven
* by the number of used and free blocks, it can take a non-deterministic time
* to execute. Typically, there are many used blocks and a much smaller number
* of used blocks making a call to this directive less expensive than a call to
* of free blocks making a call to this directive less expensive than a call to
* rtems_region_get_information().
* @endparblock
*