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

Documentation/benchmarks/mtd: Add MTD transfer rate test app docs. #16032

Merged
merged 1 commit into from
Mar 24, 2025

Conversation

tmedicci
Copy link
Contributor

@tmedicci tmedicci commented Mar 21, 2025

Summary

Add documentation entry for the mtd application (apache/nuttx-apps#3033).

Impact

Impact on user: NO.

Impact on build: NO.

Impact on hardware: NO.

Impact on documentation: YES.

Impact on security: NO.

Impact on compatibility: NO.

Testing

Build the documentation with:

$ cd Documentation; make HTML
Removing everything under '_build'...
Running Sphinx v8.1.3
loading translations [en]... done
Converting `source_suffix = ['.rst', '.md']` to `source_suffix = {'.rst': 'restructuredtext', '.md': 'restructuredtext'}`.
myst v4.0.1: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=set(), disable_syntax=[], all_links_external=False, links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_sort=True, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 1231 source files that are out of date
updating environment: [new config] 1231 added, 0 changed, 0 removed
reading sources... [100%] substitutions
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/tiago/Documents/work/espressif/projects/nuttx/nuttxspace/nuttx/Documentation/components/drivers/special/power/pm/index.rst: document is referenced in multiple toctrees: ['components/drivers/special/power/index', 'guides/changing_systemclockconfig'], selecting: guides/changing_systemclockconfig <- components/drivers/special/power/pm/index
/home/tiago/Documents/work/espressif/projects/nuttx/nuttxspace/nuttx/Documentation/platforms/arm/goldfish/goldfish_timer.rst: document is referenced in multiple toctrees: ['platforms/arm/goldfish/index', 'platforms/arm/index'], selecting: platforms/arm/index <- platforms/arm/goldfish/goldfish_timer
/home/tiago/Documents/work/espressif/projects/nuttx/nuttxspace/nuttx/Documentation/platforms/arm/nrf52/ieee802154.rst: document is referenced in multiple toctrees: ['platforms/arm/index', 'platforms/arm/nrf52/index'], selecting: platforms/arm/nrf52/index <- platforms/arm/nrf52/ieee802154
/home/tiago/Documents/work/espressif/projects/nuttx/nuttxspace/nuttx/Documentation/platforms/sim/network_linux.rst: document is referenced in multiple toctrees: ['platforms/index', 'platforms/sim/index'], selecting: platforms/sim/index <- platforms/sim/network_linux
/home/tiago/Documents/work/espressif/projects/nuttx/nuttxspace/nuttx/Documentation/platforms/sim/network_vpnkit.rst: document is referenced in multiple toctrees: ['platforms/index', 'platforms/sim/index'], selecting: platforms/sim/index <- platforms/sim/network_vpnkit
done
preparing documents... done
copying assets... 
copying downloadable files... [100%] platforms/xtensa/esp32s2/boards/esp32s2-saola-1/tone.wav
copying static files... 
Writing evaluated template result to /home/tiago/Documents/work/espressif/projects/nuttx/nuttxspace/nuttx/Documentation/_build/html/_static/language_data.js
Writing evaluated template result to /home/tiago/Documents/work/espressif/projects/nuttx/nuttxspace/nuttx/Documentation/_build/html/_static/documentation_options.js
Writing evaluated template result to /home/tiago/Documents/work/espressif/projects/nuttx/nuttxspace/nuttx/Documentation/_build/html/_static/basic.css
Writing evaluated template result to /home/tiago/Documents/work/espressif/projects/nuttx/nuttxspace/nuttx/Documentation/_build/html/_static/js/versions.js
Writing evaluated template result to /home/tiago/Documents/work/espressif/projects/nuttx/nuttxspace/nuttx/Documentation/_build/html/_static/copybutton.js
copying static files: done
copying extra files... 
copying extra files: done
copying assets: done
writing output... [100%] substitutions
generating indices... genindex done
writing additional pages... search done
copying images... [ 78%] platforms/xtensa/esp32/boards/esp32-lyrat/esp32-lyrat-v4.3-electrical-block-diagram-with-wrovcopying images... [ 91%] platforms/xtensa/esp32s3/boards/esp32s3-korvo-2/esp32-s3-korvo-2-v3.0-electrical-block-diagracopying images... [ 96%] platforms/xtensa/esp32s3/boards/esp32s3-korvo-2/esp32-s3-korvo-2-v3.0-aec-signal-collection.pcopying images... [100%] _static/images/menuconfig-debug.png
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

@github-actions github-actions bot added Area: Documentation Improvements or additions to documentation Size: S The size of the change in this PR is small labels Mar 21, 2025
@nuttxpr
Copy link

nuttxpr commented Mar 21, 2025

[Experimental Bot, please feedback here]

Yes, this PR meets the NuttX requirements. The summary is clear, the impact is well-described, and the testing demonstrates that the documentation builds successfully after the change. The testing log output is relevant and sufficient for this type of change.

Copy link
Contributor

@cederom cederom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @tmedicci :-) Just minor test -> benchmark updates and we are ready to go :-)

Copy link
Contributor

@hartmannathan hartmannathan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for improving documentation!

Add documentation entry for the `mtd` test/benchmark application.

Signed-off-by: Tiago Medicci Serrano <[email protected]>
@cederom cederom changed the title Documentation/testing: Add MTD transfer rate test app docs Documentation/benchmarks/mtd: Add MTD transfer rate test app docs. Mar 24, 2025
Copy link
Contributor

@cederom cederom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @tmedicci :-)

This PR should be merged after apache/nuttx-apps#3033 :-)

@acassis acassis merged commit 85d9078 into apache:master Mar 24, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Improvements or additions to documentation Size: S The size of the change in this PR is small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants