README should document how to disable memcache on an environment where it can't be run

Created on 22 January 2025, 3 months ago

Problem/Motivation

There is a useful feature of this module that is not documented in the README. This comment in MemcacheDriverFactory explains it:

    // If both the "servers" and "bins" settings for a specified extension are
    // an empty array, make it possible to have this module enabled and have
    // neither Memcache nor Memcached installed on this environment.

This allows you to do this on a local install where memcache isn't available:

$settings['memcache']['servers'] = [];
$settings['memcache']['bins'] = [];

This should be documented in the README.

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

šŸ› Bug report
Status

Active

Version

2.0

Component

Documentation

Created by

šŸ‡¬šŸ‡§United Kingdom joachim

Live updates comments and jobs are added and updated live.
  • Novice

    It would make a good project for someone who is new to the Drupal contribution process. It's preferred over Newbie.

Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @joachim
  • šŸ‡¬šŸ‡§United Kingdom joachim
  • First commit to issue fork.
  • šŸ‡®šŸ‡³India adwivedi008

    @joachim I have updated the readme file with the comments and the settings
    Please review and merge

  • Pipeline finished with Success
    3 months ago
    Total: 243s
    #404437
  • šŸ‡ØšŸ‡“Colombia juandhr Manizales

    Hi @adwivedi008,

    The new section provided in README looks good and will help users set up their local environments correctly. Iā€™d suggest a slight improvement in the wording for clarity.

    Would you mind refining the second sentence a bit? Something like:

    "... and bins. If both the "servers" and "bins" settings for a specified extension are empty arrays, this configuration allows developers to enable the module without requiring Memcache or Memcached in the local environment."

    This would make it clearer while keeping the same intent.

Production build 0.71.5 2024