1
0
mirror of https://github.com/php/doc-en.git synced 2026-04-29 10:13:23 +02:00
Commit Graph

56 Commits

Author SHA1 Message Date
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
Christoph M. Becker 66459d593b Fix #81365: Flipping opcache.file_cache_only is broken
Closes GH-918.
2021-09-06 14:46:47 +02: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
Christoph M. Becker a1f57404d7 Fix erroneous whitespace change
Cf. <https://github.com/php/doc-en/commit/a3bb15df3f8dd9657471db4d4f1ecd67a7c552e9#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 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 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 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 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 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
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
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
Pieter Hordijk 3b19d69c48 Added explanation for opcache.opt_debug_level directive
-- 
Provided by anonymous 82137 (me@ekins.space)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343165 c90b9560-bf6c-de11-be94-00142212c4b1
2017-09-30 19:23:04 +00:00
Pieter Hordijk 1c35c12a80 Added missing explanations for opcache directives
-- 
Provided by anonymous 82137 (me@ekins.space)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343164 c90b9560-bf6c-de11-be94-00142212c4b1
2017-09-30 15:14:22 +00:00
Pieter Hordijk 271cbda9c4 For bug #75162
-- 
Provided by anonymous 85847 (nick@noodles.net.nz)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343161 c90b9560-bf6c-de11-be94-00142212c4b1
2017-09-30 11:22:18 +00:00
Thomas Punt b2c1d554c7 OPcache is not enabled in CLI by default
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342929 c90b9560-bf6c-de11-be94-00142212c4b1
2017-08-24 17:45:44 +00:00
Pieter Hordijk c0def81f41 Documented changes of opcache cli being enabled by default on 7.1.2
#74437

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342325 c90b9560-bf6c-de11-be94-00142212c4b1
2017-04-14 14:08:55 +00:00
Pieter Hordijk cc8cbded16 Adding missing opcache.validate_root and opcache.validate_permission ini directives
Fixes https://bugs.php.net/bug.php?id=74180&edit=1

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342110 c90b9560-bf6c-de11-be94-00142212c4b1
2017-03-13 17:45:04 +00:00
Maciek Sokolewicz d200c0db9e Fixed incorrect note in opcache.force_restart_timeout description. A warning is logged as of opcache.log_verbosity_level 2 (WARNING) or higher instead of 3 (INFO) or higher.
Patch provided by Arnout Boks

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@341928 c90b9560-bf6c-de11-be94-00142212c4b1
2017-02-20 19:53:44 +00:00
Christoph Michael Becker c16956171c Document opcache.file_cache* ini directives
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@339740 c90b9560-bf6c-de11-be94-00142212c4b1
2016-07-29 12:14:07 +00:00
Jean-Sebastien Hedde 2ed5acf774 The current opcache documentation says that the selected prime number will be "bigger" than the value specified, while in source (https://github.com/php/php-src/blob/PHP-7.0/ext/opcache/zend_accelerator_hash.c#L43) it looks to be "greater than or equal" -- which makes sense.
I propose we make this clear in the documentation.

-- 
Provided by anonymous 65192 (mike.schroder@dreamhost.com)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338387 c90b9560-bf6c-de11-be94-00142212c4b1
2015-12-31 12:50:01 +00:00
Pieter Hordijk ffd1b9c9a7 Updated the max accelerated files according to: https://bugs.php.net/bug.php?id=68894
Also reworded sentence to make it clear the numbers are inclusive https://github.com/php/php-src/blob/4a2e40bb861bc3cf5fb6863e57486ed60316e97c/ext/opcache/zend_accelerator_module.c#L154

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337215 c90b9560-bf6c-de11-be94-00142212c4b1
2015-07-22 10:45:13 +00:00