Skip to content

Add pcntl and grpc docs #95

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.

Sign up for GitHub

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
jrfnl merged 8 commits into from
Mar 18, 2026
Merged

Add pcntl and grpc docs #95

Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ec9da1c
Requirements: document PCNTL as a recommended PHP extension
rodrigoprimo Mar 6, 2026
e3e23ce
Requirements: add warning about gRPC extension and parallel processing
rodrigoprimo Mar 6, 2026
a4120b0
Add details on how to handle the gRPC extension directly in the text …
rodrigoprimo Mar 13, 2026
bc0b73c
Add details on how to handle the gRPC extension directly in the text …
rodrigoprimo Mar 13, 2026
bdd42b4
Spellcheck: also ignore code blocks inside blockquotes
rodrigoprimo Mar 13, 2026
cda898f
Fix code block regex to also handle indented code blocks
rodrigoprimo Mar 16, 2026
28669ef
Move individual sniff requirements above gRPC warning
rodrigoprimo Mar 16, 2026
623c34c
cspell: fix regex doc indentation
jrfnl Mar 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion wiki/Requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ Additionally, PHP_CodeSniffer requires the following PHP extensions to be enable
- SimpleXML: used to process ruleset XML files
- XMLWriter: used to create some report formats

The following PHP extension is not required, but is strongly recommended:
The following PHP extensions are not required, but are strongly recommended:
- iconv: used for accurate character length calculation in files containing multibyte characters. Without this extension, some sniffs, like `Generic.Files.LineLength`, may report incorrect results for lines containing non-ASCII characters, as PHP_CodeSniffer will fall back to byte-based length calculations.
- PCNTL: required for parallel processing via the `--parallel` CLI option. Without this extension, PHP_CodeSniffer will not be able to check multiple files simultaneously.

> [!WARNING]
> The gRPC PHP extension is known to cause PHP_CodeSniffer to hang when running with parallel processing enabled. If the gRPC extension is loaded, make sure the `grpc.enable_fork_support` and `grpc.poll_strategy` ini settings are properly configured. See [this comment](https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/294#issuecomment-1906558549) for more details.
Copy link
Copy Markdown
Member

@jrfnl jrfnl Mar 9, 2026

Choose a reason for hiding this comment

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

Hmm... looking at this again now, I think it would be better for the docs to include the information for which you now point to an issue.

What do you think ?

Copy link
Copy Markdown

@derrabus derrabus Mar 10, 2026

Choose a reason for hiding this comment

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

How do I configure these settings "properly"? I think the documentation should include that part as well.

Copy link
Copy Markdown

@mbomb007 mbomb007 Mar 10, 2026

Choose a reason for hiding this comment

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

I think it looks good now.

Copy link
Copy Markdown
Contributor Author

@rodrigoprimo rodrigoprimo Mar 13, 2026

Choose a reason for hiding this comment

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

I think that is a good idea, @jrfnl! I've updated the warning to include the workaround directly in the text instead of pointing to the issue.

I used ```text instead of ```bash for the code block as the latter highlights <file|directory> which is not helpful in my opinion for this particular case.

The phpcs command added here triggered a cspell error. I opted to update the cspell markdown_code_block regex pattern to also ignore code blocks inside blockquotes. The previous pattern only matched code blocks starting with optional whitespace, so it didn't match the > ``` syntax used in this warning. Let me know if you prefer a different approach, such as applying this fix in a separate PR or simply adding the word that triggers the error to the allowlist.


Individual sniffs may have additional requirements such as external applications and scripts. See the [Configuration Options](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Configuration-Options) manual page for a list of these requirements.
Comment thread
jrfnl marked this conversation as resolved.
Outdated
Loading