Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

demos: remove inconsistent readme #5626

Merged
merged 3 commits into from Feb 12, 2024
Merged

demos: remove inconsistent readme #5626

merged 3 commits into from Feb 12, 2024

Conversation

IAMMX
Copy link
Contributor

@IAMMX IAMMX commented Feb 8, 2024

Description of the feature or fix

fix #5609
demos: remove inconsistent readme.

Notes

@kisvegabor
Copy link
Member

Thank you! According to the feedback of the users it's not always clear how to interpret the result of the benchmark. To have some docs about it please add this comment to lv_demo_benchmark() in lv_demo_benchmark.h:

/**
 * Run all benchmark scenes.
 * 
 * On the summary end screen the values shall be interpreted according to the followings:
 * - CPU usage: 
 *    - If `LV_SYSMON_GET_IDLE` is not modified it's measured based on the time spent in
 *      `lv_timer_handler`. 
 *    - If an (RT)OS is used `LV_SYSMON_GET_IDLE` can be changed to a custom function
 *      which returns the idle percentage of idle task.
 * 
 * - FPS: LVGL attempted to render this many times in a second. It's limited based on `LV_DEF_REFR_PERIOD`
 * 
 * - Render time: LVGL spent this much time with rendering only. It's not aware of task yielding,
 *   but simply the time difference between the start and end of the rendering is measured
 * 
 * - Flush time: It's the sum of 
 *     - the time spent in the `fluch_cb` and 
 *     - the time spent with waiting for flush ready.
 */
void lv_demo_benchmark(void);

@IAMMX
Copy link
Contributor Author

IAMMX commented Feb 11, 2024

Thank you! According to the feedback of the users it's not always clear how to interpret the result of the benchmark. To have some docs about it please add this comment to lv_demo_benchmark() in lv_demo_benchmark.h

Done.

@kisvegabor
Copy link
Member

Thank you!

@kisvegabor kisvegabor merged commit a3624f6 into lvgl:master Feb 12, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Several Readme in the demo are completely inconsistent with the content
3 participants