NGINX command line signal flag (`-s`) docs should document that this flag should only be used on Windows
Nobody has claimed this yet.
- Dominant language
- XSLT
- Stars
- 89
- Forks
- 60
- Avg merge
- 19h 11m
- Merged PRs (30d)
- 12
Description
Bug Overview
When looking through our Command-line parameters docs (https://nginx.org/en/docs/switches.html), the nginx -s signal parameter does not include any documentation regarding how the flag was developed for usage in Windows platforms and is not recommended on Unix platforms (see https://github.com/nginx/nginx/discussions/720#discussioncomment-13437242 for more context).
Expected Behavior
We should update our docs (https://nginx.org/en/docs/switches.html) to reflect that the -s flag is only recommended on Windows builds (https://nginx.org/en/docs/windows.html) and link to https://nginx.org/en/docs/control.html#reconfiguration for more info on how to properly reload NGINX. https://nginx.org/en/docs/control.html#reconfiguration could probably me updated too to give a few examples on how to reload the NGINX config on the most popular distros (it tends to involve a service reload).
Steps to Reproduce the Bug
Check https://nginx.org/en/docs/switches.html
Environment Details
Production instance of https://nginx.org/
Additional Context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Command-line parameters page at nginx.org/en/docs/switches.html and review the existing -s signal entry alongside the Windows documentation. Update the -s guidance to explain its Windows recommendation and link to the reconfiguration section at nginx.org/en/docs/control.html#reconfiguration; consider the requested distro reload examples only if that scope is confirmed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nginx
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100