Commit graph

77 commits

Author SHA1 Message Date
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
Christoph Michael Becker
a9a499aaab Update opcache.optimization_level default value
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@348511 c90b9560-bf6c-de11-be94-00142212c4b1
2019-12-14 17:10:03 +00:00
Christoph Michael Becker
d197a1438a Document ffi.preload and opcache.preload_user directives
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@348203 c90b9560-bf6c-de11-be94-00142212c4b1
2019-10-23 07:13:34 +00:00
Christoph Michael Becker
4360f13f4b Fix #78652: 7.1 migration guide says default opcache.enable_cli=1, was reverted to 0
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@348151 c90b9560-bf6c-de11-be94-00142212c4b1
2019-10-13 15:22:40 +00:00
Christoph Michael Becker
bebe711655 Discourage disabling of opcache.file_cache_fallback
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347411 c90b9560-bf6c-de11-be94-00142212c4b1
2019-05-11 14:17:19 +00:00
Christoph Michael Becker
cddcb4c4cc Fix #77592: Incorrect changelog for opcache.optimization_level
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346764 c90b9560-bf6c-de11-be94-00142212c4b1
2019-02-09 13:45:21 +00:00
Christoph Michael Becker
9c75621343 Inlcude OPcache ini directives in ini.list
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346618 c90b9560-bf6c-de11-be94-00142212c4b1
2019-01-21 16:10:23 +00:00
Christoph Michael Becker
8eda99cb3b Document opcache.preload
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346615 c90b9560-bf6c-de11-be94-00142212c4b1
2019-01-21 15:27:35 +00:00
Christoph Michael Becker
6df12e9c2b opcache_get_status() returns FALSE on failure
Cf. <https://github.com/php/php-src/pull/2031#issuecomment-427592472>.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345790 c90b9560-bf6c-de11-be94-00142212c4b1
2018-10-06 22:51:37 +00:00
Pasindu De Silva
d73588ddcb opcache.inherited_hack removed in PHP 7.3.0
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345703 c90b9560-bf6c-de11-be94-00142212c4b1
2018-09-28 02:45:10 +00:00
Christoph Michael Becker
55097bb873 Update default ini values
Based on a patch provided by an anonymous user.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345610 c90b9560-bf6c-de11-be94-00142212c4b1
2018-09-07 14:56:40 +00:00
Jakub Vrana
e6cc6e33e9 opcache.load_comments is removed (bug #75516)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344079 c90b9560-bf6c-de11-be94-00142212c4b1
2018-01-29 22:13:17 +00:00
Jakub Vrana
496c99cd7c Fix default value of opcache.optimization_level (bug #75697)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344077 c90b9560-bf6c-de11-be94-00142212c4b1
2018-01-29 21:59:38 +00:00
Jakub Vrana
7c50ead1ed Fix versions based on parsed php-src
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344068 c90b9560-bf6c-de11-be94-00142212c4b1
2018-01-29 15:23:17 +00:00
Jakub Vrana
cf1434873d Use bool instead of boolean in parameters
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343890 c90b9560-bf6c-de11-be94-00142212c4b1
2018-01-25 15:52:49 +00:00
Jakub Vrana
331fbfeac5 Use bool instead of boolean in return types
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343889 c90b9560-bf6c-de11-be94-00142212c4b1
2018-01-25 15:50:10 +00:00
Nikita Popov
954be33208 Note removal of opcache.fast_shutdown
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343672 c90b9560-bf6c-de11-be94-00142212c4b1
2017-12-18 20:49:53 +00:00