93 Commits

Author SHA1 Message Date
Mikhail Alferov
04d9aded7b Add class="extension" attribute to <filename> tags which refer to file extensions (#3870) 2024-10-15 13:10:10 +01:00
haszi
48ce43fe79 Remove empty resources pages (#3545)
Co-authored-by: haszi <haszika80@gmail.com>
2024-07-26 02:17:29 +01:00
haszi
605553e228 Remove empty requirements pages (#3464)
Co-authored-by: haszi <haszika80@gmail.com>
2024-07-07 14:34:34 +01:00
Pere Orga
7bdf6028aa opcache: misc fixes (#3434)
- Use correct type for default configuration options
- Use `<literal>` and `<code>` tags consistently
- Mark all windows-only options in the Changelog column, for consistency
- Slightly improve wording in opcache.file_cache_fallback
- Use `&null;` consistently.
2024-06-05 00:19:13 +01:00
Gina Peter Banyard
d4d5216e7a [skip-revcheck] Replace PHP_INI_* with INI_* constants
Performed via a bash script which can be found on PR GH-3140

Closes GH-3140

Co-authored-by: haszi <haszika80@gmail.com>
2024-01-26 14:00:36 +00:00
Kamil Tekiela
28529d3539 Remove unnecessary parentheses 2023-12-11 21:51:20 +01:00
Yoshinari Takaoka
87f9d3cd28 [PHP 8.3] Removed opcache.consistency_checks INI directive (#2915) 2023-11-06 11:59:23 +00:00
Pere Orga
9829ec03d3 OPcache: explain why setting file_update_protection to 0 may improve performance (#2610)
Co-authored-by: George Peter Banyard <girgias@php.net>
2023-07-29 06:02:19 +01:00
Pere Orga
a753cf2936 OPcache: clarify timestamps can be checked on compile-time (#2619) 2023-07-29 06:02:03 +01:00
Pere Orga
597c856ee7 OPcache: clarify validate_timestamps considering other options (#2609)
Co-authored-by: George Peter Banyard <girgias@php.net>
2023-07-28 03:22:15 +01:00
Yoshinari Takaoka
8845dc32b5 added opcache_get_status reference. 2023-06-27 07:43:30 +09:00
HypeMC
30d6d50d6d Update when opcache_reset returns false (#2054) 2023-06-26 16:55:08 +01:00
Christoph M. Becker
56f49b5b99 Fix GH-2172 (Remove opcache.fast_shutdown from OPcache installation page)
We do not remove it yet, but rather add a respective comment.
2023-01-12 10:50:01 +01:00
Su, Tao
c7a7f596c4 Clarify jit_debug option and link to zend_jit.h
Clarify how to search for jit_debug options, and add an external link to
PHP zend_jit.h source file.

Hopefully, the clarification and link can save PHP the developer's and
user's time/effort with a simple click jumping to where they should go.

This patch has been verified on my local machine and link works well.

This risk is that doc viewer could get a dead link if PHP source code
file location moved or name changed in future. We just hope this is a
rare case and will not happen so frequently. We depend on user's
bug-report to fix any issue.

Reviewed-by: Christoph M. Becker <cmbecker69@gmx.de>
Signed-off-by: Su, Tao <tao.su@intel.com>

Closes GH-1340.
2022-12-26 13:15:53 +01:00
Arnaud Le Blanc
fe64ac9a1e Clarify opcache.preload_user behavior (#1874) 2022-10-14 14:09:19 +02:00
wxue1
9e34a0a473 Update document for jit_max_root_traces
Add more explanation for root trace and side trace in PHP manual.
Includes the influence when reach the maximum value of
opcache.jit_max_root_traces or opcache.jit_max_side_traces.

Signed-off-by:Wang, Xue <xue1.wang@intel.com>

Closes GH-1715.
2022-07-23 12:51:58 +02:00
Christoph M. Becker
46048f1cb2 Fix GH-1576: New opcache.record_warnings setting is undocumented 2022-05-09 10:49:39 +02:00
Tony Su
092a101134 Clarification for usage of JIT tunable options
This patch clarifies the usage of the four JIT tunable options -
jit_hot_{loop,func,return,side_exit} - in PHP manual which end users
should be aware of before they start to tune these options.

1. Valid value range
2. Default value will be used in case beyond valid range
3. Special case of zero value

The patch was verified on my machine with phd local website.

Signed-off-by: Su, Tao <tao.su@intel.com>

Closes GH-1350.
2022-01-19 11:56:57 +01:00
Tony Su
c46a5fe7bc Clarification of jit_bisect_limit usage
As a new bird to PHP interpreter, I tried to set jit_bisect_limit
with jit=tracing in order to debug/probe PHP JIT feature, but
failed to hit my breakpoint and hence got confused.

I found that jit_bisect_limit only works under special JIT trigger
mode like 0: on script load, or 1: on first execution, after heavily
reading source code and trial-and-error experiments.

So, I would like to clarify the usage in PHP manual.
Hopefully, this can save time cost and reduce confusion of new PHP
interpreter developers.

The patch is verified on my local machine with phd build and the
web content and link looks good.

Signed-off-by: Su, Tao <tao.su@intel.com>

Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>

Closes GH-1337.
2022-01-17 22:15:29 +01:00
Christoph M. Becker
c7d6db0d24 Clarify meaning of opcache.optimization_level 2022-01-14 10:04:10 +01:00
Tony Su
c8696908a1 Clarification for setting 0 to jit_hot_loop/func
I tried to tell JIT to compile every loops and functions
by setting both opcache.jit_hot_loop and opcache.jit_hot_functions
to 0, but failed to get expected result.

After having read the source code and simple experiments, I found
that setting these two options to 0 will actually disable JIT to
compile any iterations and calls.

So I would like to add clarifications for this behavior in PHP manual.

Signed-off-by: Su, Tao <tao.su@intel.com>

Closes GH-1324.
2022-01-13 08:38:13 +01:00
Frederik Bosch
50b104c116 Fix #75070: Opcache functions only apply to in-memory cache
Closes GH-1030.
2021-10-15 15:31:13 +02:00
Christoph M. Becker
66459d593b Fix #81365: Flipping opcache.file_cache_only is broken
Closes GH-918.
2021-09-06 14:46:47 +02:00
Larry Garfield
d348943ddf Clarify preloading and constant behavior. (#144) 2021-08-18 11:23:52 -04:00
George Peter Banyard
cbac1ecf71 Fix lone section order issues in various extensions
Part of #658
2021-06-06 18:03:03 +01:00
Christoph M. Becker
7c6c83d08e Document opcache.cache_id for IIS app pools
Cf. <https://bugs.php.net/80812>.
2021-03-02 12:44:37 +01:00
Christoph M. Becker
a5a946a88e opcache.cache_id defaults to "" 2021-02-10 15:13:44 +01:00
Yoshinari Takaoka
924daa2dcd Added PHP 8 into versions.xml for opcache based on stubs.
Closes GH-379.
2021-01-24 11:48:26 +01:00
Christoph M. Becker
a1f57404d7 Fix erroneous whitespace change
Cf. <a3bb15df3f (commitcomment-45824230)>.
2021-01-10 23:03:09 +01:00
Christoph M. Becker
a3bb15df3f Remove interals2 book
The "Hacker's guide" is grossly outdated (it is about ZendEngine 2;
some stuff even about ZE1, although ZE4 is current), and nobody is
working on it for years.  Therefore we remove this part of the manual;
users are better off reading external resources, such as
<http://www.phpinternalsbook.com/>.

Closes GH-152.
2021-01-10 15:54:24 +01:00
Larry Garfield
ded1af5913 Order the JIT configuration options in definition order.
Closes GH-229.
2021-01-08 19:42:59 +01:00
Christoph Michael Becker
9e1d1413ac Fix #80434: Missing "s" in documentation for "opcache.jit_max_loop_unrolls"
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351699 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-27 14:57:16 +00:00
Christoph Michael Becker
60726f0c6c opcache.max_wasted_percentage only triggers restart on insufficient free memory
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351415 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-17 16:56:47 +00:00
Christoph Michael Becker
3cbc58c1af Generate opcache methodsynopses based on stubs
Patch contributed by Máté Kocsis <kocsismate@woohoolabs.com>.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351408 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-17 11:54:32 +00:00
Christoph Michael Becker
36b81969f8 opcache.force_restart_timeout is not supported on Windows
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351404 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-17 10:49:42 +00:00
Christoph Michael Becker
49328c2160 Remove obsolete PHP 5 specific info regarding OPcache installation
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351292 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-07 16:30:41 +00:00
Christoph Michael Becker
dfcd2c10b7 Document JIT related OPcache INI settings
Co-authored-by: Nikita Popov <nikita.ppv@googlemail.com>
Co-authored-by: Dmitry Stogov <dmitry@zend.com>


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351205 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-03 23:58:37 +00:00
Christoph Michael Becker
fcf21c2541 Remove PHP 5 specific info from OPcache INI page
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351152 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-02 18:40:01 +00:00
Christoph Michael Becker
b95d28e6ec Fix return types
Functions which return false on failure should state that in their
signature as well.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351135 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-02 15:52:35 +00:00
Christoph Michael Becker
86e6094e86 Use canonical type names
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351133 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-02 15:39:04 +00:00
George Peter Banyard
aee38ec9b5 Fix typo in opcache ini documentation
-- 
Provided by anonymous 318 (adrian.kinberger@gmail.com)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350882 c90b9560-bf6c-de11-be94-00142212c4b1
2020-10-14 16:58:52 +00:00
Christoph Michael Becker
83c41a8f69 Document configuring opcache preloading
Patch provided by Larry Garfield.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350245 c90b9560-bf6c-de11-be94-00142212c4b1
2020-07-30 08:21:47 +00:00
Christoph Michael Becker
bc35cff061 Preloading is not supported on Windows
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350233 c90b9560-bf6c-de11-be94-00142212c4b1
2020-07-28 09:15:54 +00:00
Christoph Michael Becker
0bd5779b20 Add availability info for opcache.huge_code_pages
Cf. <https://bugs.php.net/bug.php?id=79751#1593553471>.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350090 c90b9560-bf6c-de11-be94-00142212c4b1
2020-06-30 22:12:16 +00:00
Christoph Michael Becker
56e2aa4ff4 opcache.huge_code_pages is boolean, not string
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350088 c90b9560-bf6c-de11-be94-00142212c4b1
2020-06-30 14:25:00 +00:00
Christoph Michael Becker
fc5c96bbc1 Document important OPcache settings for Windows
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350081 c90b9560-bf6c-de11-be94-00142212c4b1
2020-06-24 14:48:11 +00:00
Christoph Michael Becker
b166d394e6 Document behavior of out-of-range INI settings
Cf. <https://bugs.php.net/79644>.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350001 c90b9560-bf6c-de11-be94-00142212c4b1
2020-06-02 11:38:01 +00:00
Christoph Michael Becker
d01f21cbd3 Document other primes for opcache.max_accelerated_files
Patch provided by tandre@php.net.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@349735 c90b9560-bf6c-de11-be94-00142212c4b1
2020-05-02 16:52:39 +00:00
Tyson Andre
552d72de63 Document when opcache.opt_debug_level was added
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@349606 c90b9560-bf6c-de11-be94-00142212c4b1
2020-04-03 21:15:03 +00:00
Christoph Michael Becker
2a49694d0b Document opcache.cache_id
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@349015 c90b9560-bf6c-de11-be94-00142212c4b1
2020-01-25 16:48:27 +00:00