Skip to content

docs: Mention --disable-sigusr1 in getting started guide #7857

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

Merged
merged 3 commits into from
Jun 16, 2025

Conversation

dreusel
Copy link
Contributor

@dreusel dreusel commented Jun 10, 2025

Description

Mention --disable-sigusr1 in getting started guide

Validation

I took it from the node.js documentation site (https://nodejs.org/api/cli.html#--disable-sigusr1)

Related Issues

None so far

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run pnpm format to ensure the code follows the style guide.
  • I have run pnpm test to check if all tests are passing.
  • I have run pnpm build to check if the website builds without errors.
  • I've covered new added functionality with unit tests if necessary.

Signed-off-by: Daniel <16339876+dreusel@users.noreply.github.com>
@Copilot Copilot AI review requested due to automatic review settings June 10, 2025 08:53
@dreusel dreusel requested a review from a team as a code owner June 10, 2025 08:53
Copy link

vercel bot commented Jun 10, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nodejs-org ✅ Ready (Inspect) Visit Preview Jun 16, 2025 2:41am

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the getting started guide by adding an entry for the --disable-sigusr1 flag in the debugging table.

  • Added documentation for the --disable-sigusr1 flag
  • Provides version details indicating when the flag was introduced
Comments suppressed due to low confidence (1)

apps/site/pages/en/learn/getting-started/debugging.md:132

  • Consider listing versions in ascending order (e.g., v22.14.0, v23.7.0) for improved clarity and consistency with other version notations.
| --disable-sigusr1                  | Disable the ability of starting a debugging session by sending a SIGUSR1 signal to the process (since Node v23.7.0, v22.14.0).                        |

@dreusel dreusel changed the title Mention --disable-sigusr1 in getting started guide docs: Mention --disable-sigusr1 in getting started guide Jun 10, 2025
@avivkeller
Copy link
Member

That's a little advanced for beginners, no?

@dreusel
Copy link
Contributor Author

dreusel commented Jun 10, 2025

That's a little advanced for beginners, no?

Possibly so. I landed on the page as a non-beginner and it would have helped me, but I could imagine the maintainer not adding it for your reason.
The reason it would have helped me is perhaps also a bit of a temporary sitation: As the flag is quite new it doesn't easily pop up in searches and various AI's will just tell you that it's not possible to completely disable the debugger functionality.

@avivkeller
Copy link
Member

avivkeller commented Jun 10, 2025

I mean, it is a beginner page, but it doesn't hurt to add the flag, so LGTM. It's not like we are over complicating it, it's a single table entry

Copy link

codecov bot commented Jun 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.43%. Comparing base (f93bd4b) to head (dc2eee4).
Report is 7 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7857   +/-   ##
=======================================
  Coverage   75.43%   75.43%           
=======================================
  Files         101      101           
  Lines        8305     8306    +1     
  Branches      218      218           
=======================================
+ Hits         6265     6266    +1     
  Misses       2038     2038           
  Partials        2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Co-authored-by: Aviv Keller <me@aviv.sh>
Signed-off-by: Daniel <16339876+dreusel@users.noreply.github.com>
@mikeesto mikeesto added the github_actions:pull-request Trigger Pull Request Checks label Jun 16, 2025
@mikeesto mikeesto enabled auto-merge June 16, 2025 02:41
@github-actions github-actions bot removed the github_actions:pull-request Trigger Pull Request Checks label Jun 16, 2025
Copy link
Contributor

github-actions bot commented Jun 16, 2025

Lighthouse Results

URL Performance Accessibility Best Practices SEO Report
/en 🟢 100 🟢 100 🟢 100 🟢 91 🔗
/en/about 🟢 100 🟢 96 🟢 100 🟠 82 🔗
/en/about/previous-releases 🟢 100 🟢 96 🟢 100 🟠 83 🔗
/en/download 🟢 98 🟢 100 🟢 100 🟢 91 🔗
/en/blog 🟢 100 🟢 100 🟢 96 🟢 92 🔗

@mikeesto mikeesto added this pull request to the merge queue Jun 16, 2025
Merged via the queue into nodejs:main with commit 67219ab Jun 16, 2025
15 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.

3 participants