Fix #74284: Update runtime configuration page for memcached #53

jboulen · 2020-03-02T12:24:51Z

I based my work on php-memcached/memcached.ini.

TysonAndre · 2020-03-10T20:44:11Z

reference/memcached/ini.xml

@@ -85,14 +139,32 @@
     </row>
     <row>
      <entry><link linkend="ini.memcached.serializer">memcached.serializer</link></entry>
-      <entry>php</entry>
+      <entry>igbinary</entry>


This should continue to be php - PHP is the default. igbinary can only be used if the ini setting is changed, and the igbinary extension is installed.

The comment on default memcached.ini indicates :

; The default is igbinary if available, then msgpack if available, then php otherwise.
;memcached.serializer = "igbinary"

So I will update this line too.

The default is igbinary if available and php otherwise.

But what default value should we display in documentation ?

I think using "php" as default, but explaining that it depends on compile time (options), might be best.

Can I use changelog column or it's better to let explanation in settings description ?

I'm sorry. I was mistaken, this was right -- I didn't expect igbinary and msgpack to be the default and thought it'd be opt-in.

If igbinary is available, it's igbinary, if msgpack is available, it's msgpack, and otherwise, it's php.

https://github.com/php-memcached-dev/php-memcached/blob/v3.1.5/php_memcached_private.h#L105-L114

#if defined(HAVE_MEMCACHED_IGBINARY) # define SERIALIZER_DEFAULT SERIALIZER_IGBINARY # define SERIALIZER_DEFAULT_NAME "igbinary" #elif defined(HAVE_MEMCACHED_MSGPACK) # define SERIALIZER_DEFAULT SERIALIZER_MSGPACK # define SERIALIZER_DEFAULT_NAME "msgpack" #else # define SERIALIZER_DEFAULT SERIALIZER_PHP # define SERIALIZER_DEFAULT_NAME "php" #endif /* HAVE_MEMCACHED_IGBINARY / HAVE_MEMCACHED_MSGPACK */

php-memcached-dev/php-memcached@abd0cae#diff-af2b8e0bfbc900b4a13b10a7af197df3 - It seems like igbinary's been the default if available since 1.0.1, as far as I can tell (commit was December 29th, 2009) - https://pecl.php.net/package/memcached

cmb69 · 2020-03-11T10:02:15Z

I can't really comment on memcached, but please note that the PHP manual is supposed to document also older versions. So if some of these changes would have been introduced only in recent versions, respective changelog entries should be added (or be documented otherwise).

jboulen · 2020-03-11T10:18:17Z

I will try to fill changelog column. Thank you for feedback.

jboulen · 2020-03-19T10:58:39Z

I tried to update information about availability or depreciation of each variable.

If someone can review this PR, it will be great !

cmb69 · 2020-03-19T11:10:02Z

@sodabrew, since you seem to be the current lead maintainer, could you please review?

afilina · 2021-01-07T20:11:58Z

Pinging @sodabrew since this PR seems to have fell through the cracks.

sodabrew · 2021-01-08T23:39:47Z

Thanks for the nudge, this is great. ~~Needs to be rebased, I'll take care of that.~~ I'm not a PHP committer, so this will need to be handled by someone on team PHP. But as the maintainer of php-memcached, I've added my approval!

sodabrew

To the maintainers: please do rebase/merge this, as the current maintainer of php-memcached, this looks good!

Girgias · 2021-01-09T00:42:45Z

reference/memcached/ini.xml

      <entry>PHP_INI_ALL</entry>
-      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
+      <entry>Available since memcached 0.1.0.</entry>


Suggested change

<entry>Available since memcached 0.1.0.</entry>

<entry>Available as of memcached 0.1.0.</entry>

Please do the following change for all other entries

Girgias · 2021-01-09T00:43:03Z

reference/memcached/ini.xml

   <varlistentry xml:id="ini.memcached.sess-locking">
     <term>
      <parameter>memcached.sess_locking</parameter>
-      <type>integer</type>
+      <type>boolean</type>


Suggested change

<type>boolean</type>

<type>bool</type>

Girgias · 2021-01-09T00:43:12Z

reference/memcached/ini.xml

    <varlistentry xml:id="ini.memcached.sess-consistent-hash">
     <term>
      <parameter>memcached.sess_consistent_hash</parameter>
-      <type>integer</type>
+      <type>boolean</type>


Suggested change

<type>boolean</type>

<type>bool</type>

Girgias · 2021-01-09T00:43:26Z

reference/memcached/ini.xml

    <varlistentry xml:id="ini.memcached.sess-binary">
     <term>
      <parameter>memcached.sess_binary</parameter>
-      <type>integer</type>
+      <type>boolean</type>


Suggested change

<type>boolean</type>

<type>bool</type>

Girgias · 2021-01-09T00:43:37Z

reference/memcached/ini.xml

    <varlistentry xml:id="ini.memcached.sess-randomize-replica-read">
     <term>
      <parameter>memcached.sess_randomize_replica_read</parameter>
-      <type>integer</type>
+      <type>boolean</type>


Suggested change

<type>boolean</type>

<type>bool</type>

Girgias · 2021-01-09T00:44:30Z

reference/memcached/ini.xml

+    <varlistentry xml:id="ini.memcached.default-connect-timeout">
+     <term>
+      <parameter>memcached.default_connect_timeout</parameter>
+      <type>integer</type>


Suggested change

<type>integer</type>

<type>int</type>

```Apply this change to everything below

Girgias

Types should be int or bool and user as of instead of since

cmb69 · 2021-01-09T12:40:52Z

Thank you!

TysonAndre mentioned this pull request Mar 10, 2020

Document Memcached::SERIALIZER_MSGPACK and Memcached::SERIALIZER_JSON_ARRAY php-memcached-dev/php-memcached#454

Open

TysonAndre reviewed Mar 10, 2020

View reviewed changes

jboulen force-pushed the memcached branch from 845b3a1 to 659c393 Compare March 11, 2020 17:17

Fix #74284: Update runtime configuration page for memcached

181ce52

jboulen force-pushed the memcached branch from cd03f09 to 181ce52 Compare March 19, 2020 10:46

sodabrew approved these changes Jan 8, 2021

View reviewed changes

Girgias reviewed Jan 9, 2021

View reviewed changes

Girgias requested changes Jan 9, 2021

View reviewed changes

php-pulls closed this in c2db151 Jan 9, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix #74284: Update runtime configuration page for memcached #53

Fix #74284: Update runtime configuration page for memcached #53

jboulen commented Mar 2, 2020

TysonAndre Mar 10, 2020

jboulen Mar 11, 2020

cmb69 Mar 11, 2020

jboulen Mar 11, 2020

TysonAndre Mar 11, 2020 •

edited

Loading

TysonAndre Mar 11, 2020

cmb69 commented Mar 11, 2020

jboulen commented Mar 11, 2020

jboulen commented Mar 19, 2020 •

edited

Loading

cmb69 commented Mar 19, 2020

afilina commented Jan 7, 2021

sodabrew commented Jan 8, 2021 •

edited

Loading

sodabrew left a comment •

edited

Loading

Girgias Jan 9, 2021

Girgias Jan 9, 2021

Girgias Jan 9, 2021

Girgias Jan 9, 2021

Girgias Jan 9, 2021

Girgias Jan 9, 2021

Girgias left a comment

cmb69 commented Jan 9, 2021

	<entry>Available since memcached 0.1.0.</entry>
	<entry>Available as of memcached 0.1.0.</entry>

	<type>integer</type>
	<type>int</type>
	```Apply this change to everything below

Fix #74284: Update runtime configuration page for memcached #53

Fix #74284: Update runtime configuration page for memcached #53

Conversation

jboulen commented Mar 2, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TysonAndre Mar 11, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cmb69 commented Mar 11, 2020

jboulen commented Mar 11, 2020

jboulen commented Mar 19, 2020 • edited Loading

cmb69 commented Mar 19, 2020

afilina commented Jan 7, 2021

sodabrew commented Jan 8, 2021 • edited Loading

sodabrew left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Girgias left a comment

Choose a reason for hiding this comment

cmb69 commented Jan 9, 2021

TysonAndre Mar 11, 2020 •

edited

Loading

jboulen commented Mar 19, 2020 •

edited

Loading

sodabrew commented Jan 8, 2021 •

edited

Loading

sodabrew left a comment •

edited

Loading