Skip to content

docs/audio_tone: Add documentation about the audio tone driver#19418

Merged
xiaoxiang781216 merged 1 commit into
apache:masterfrom
linguini1:audio-tone-docs
Jul 13, 2026
Merged

docs/audio_tone: Add documentation about the audio tone driver#19418
xiaoxiang781216 merged 1 commit into
apache:masterfrom
linguini1:audio-tone-docs

Conversation

@linguini1

Copy link
Copy Markdown
Contributor

Summary

This commit adds some documentation about the audio tone driver, how to use it and links to it from the main audio component page. I also added some back links to other audio docs there for convenience.

Impact

Docs only.

Testing

Local build.

This commit adds some documentation about the audio tone driver, how to
use it and links to it from the main audio component page. I also added
some back links to other audio docs there for convenience.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
@linguini1 linguini1 requested a review from raiden00pl as a code owner July 12, 2026 21:33
@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 Jul 12, 2026
@github-actions

Copy link
Copy Markdown

MemBrowse Memory Report

hifive1-revb

@linguini1

Copy link
Copy Markdown
Contributor Author

Just like the other CI items, we can maybe update the runs so that membrowse doesn't run on docs only PRs. What do you think @simbit18 ?

@xiaoxiang781216 xiaoxiang781216 merged commit c15a3bf into apache:master Jul 13, 2026
15 checks passed
@simbit18

simbit18 commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

@linguini1 I agree, too.
Hi @michael-membrowse, could you exclude the membrowse run where the PR contains only documentation?

Add these other cases as well, so we can save some time.

pull_request:
    paths-ignore:
      - "AUTHORS"
      - "CONTRIBUTING.md"
      - "**/CODEOWNERS"
      - "Documentation/**"
  push:
    paths-ignore:
      - "AUTHORS"
      - "CONTRIBUTING.md"
      - "Documentation/**"

@michael-membrowse

Copy link
Copy Markdown
Contributor

Hi @simbit18,
When a PR doesn't contain real code change,
MemBrowse runs in "identical" mode.
Meaning there is no build and no report generation. Only upload of metadata so the commit chain in the MemBrowse portal will be intact. Its very minimal in terms of CI minutes.

@simbit18

Copy link
Copy Markdown
Contributor

Hi @michael-membrowse , here you can see the time taken by MemBrowse to run this documentation-only PR (38m 10s )
https://github.com/apache/nuttx/actions/runs/29209845109/usage

@linguini1

Copy link
Copy Markdown
Contributor Author

The most minimal number of minutes is none at all!

@linguini1 linguini1 deleted the audio-tone-docs branch July 13, 2026 21:43
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.

5 participants