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

Doc: Stack overflow check #15653

Merged
merged 1 commit into from
Jan 23, 2025
Merged

Doc: Stack overflow check #15653

merged 1 commit into from
Jan 23, 2025

Conversation

W-M-R
Copy link
Contributor

@W-M-R W-M-R commented Jan 22, 2025

Note: Please adhere to Contributing Guidelines.

Summary

Docu: Stack overflow check

Impact

Update this section, where applicable, on how change affects users,
build process, hardware, documentation, security, compatibility, etc.

Testing

Update this section with details on how did you verify the change,
what Host was used for build (OS, CPU, compiler, ..), what Target was
used for verification (arch, board:config, ..), etc. Providing build
and runtime logs from before and after change is highly appreciated.

@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 Jan 22, 2025
@nuttxpr
Copy link

nuttxpr commented Jan 22, 2025

[Experimental Bot, please feedback here]

No, this PR does not fully meet the NuttX requirements. While it provides a title related to stack overflow checking in the documentation, it lacks crucial information.

Here's what's missing:

  • Summary: It needs a detailed explanation of why the documentation change is necessary (e.g., was it incorrect, missing, or unclear?). It also needs to describe what exactly changed in the documentation (e.g., added a section on stack overflow checking, clarified existing information, fixed an error).
  • Impact: The impact section is completely empty. At minimum, it should state "NO" for all impact categories if there is truly no impact. Even for documentation changes, there might be impact (e.g., clarifying something that could affect how users configure their systems). If the documentation clarifies how to prevent stack overflows, then there is arguably a security impact.
  • Testing: The testing section is also empty. While documentation changes don't require the same level of testing as code changes, there should be some verification. For example, "Verified that the updated documentation renders correctly and is consistent with the code." If there are code changes associated with this documentation update (even in a separate PR), it should be mentioned here.

In short, the PR needs to be much more descriptive to meet the requirements. Just stating the title of the change isn't enough. The reviewer needs context to understand the purpose and validate the change.

@xiaoxiang781216
Copy link
Contributor

please fix ci error, @W-M-R

@xiaoxiang781216 xiaoxiang781216 linked an issue Jan 22, 2025 that may be closed by this pull request
1 task
Documentation/guides/stackcheck.rst Outdated Show resolved Hide resolved
Documentation/guides/stackcheck.rst Outdated Show resolved Hide resolved
Signed-off-by: wangmingrong1 <[email protected]>
@xiaoxiang781216 xiaoxiang781216 changed the title Docu: Stack overflow check Doc: Stack overflow check Jan 23, 2025
@xiaoxiang781216 xiaoxiang781216 merged commit 7774271 into apache:master Jan 23, 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.

[DOCUMENTATION] Open hardware stack check
4 participants