Problem/Motivation

ReplicaDatabaseIgnoreSubscriber has the following documentation:

    // ... Code that wants to disable the replica server should
    // use the db_set_ignore_replica() function to set
    // $_SESSION['ignore_replica_server'] to the timestamp after which the replica
    // can be re-enabled.

There is no function db_set_ignore_replica(), though. The actual function is called db_ignore_replica().

Proposed resolution

Replace db_set_ignore_replica() with db_ignore_replica().

For extra credit reformat the code block so that every line breaks at 80 characters.

Remaining tasks

After this issue is committed, re-open #2488440: Reformat comments to 80 characters in ReplicaDatabaseIgnoreSubscriber::checkReplicaServer() comments.

User interface changes

None

API changes

None

Beta phase evaluation

Reference: https://www.drupal.org/core/beta-changes
Issue category Bug: see #9
Issue priority Minor: see #9
Unfrozen changes Unfrozen because it only changes documentation.
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

joshi.rohit100’s picture

Status: Active » Needs review
FileSize
2 KB
tstoeckler’s picture

Status: Needs review » Reviewed & tested by the community

Awesome, thanks!

xjm’s picture

Status: Reviewed & tested by the community » Needs work

So actually (contrary to the suggestion in summary), we should not do cleanups like rewrapping comments to meet our 80-character limit in a patch that's not specifically for that, as it adds a lot of out-of-scope things to review that are not related to the bugfix in the patch. For more information, see: http://webchick.net/please-stop-eating-baby-kittens

Let's update this patch to only make the change in the title. Thanks!

tstoeckler’s picture

Status: Needs work » Reviewed & tested by the community

Nope. This is a 2Kb patch. Let's stay realistic please. In the time you wrote that comment you could have already have reviewed the patch.

xjm’s picture

Status: Reviewed & tested by the community » Needs work

@tstoeckler, of course I could. (Edit: actually I did.) But @joshi.rohit100 is a new contributor who has been submitting a lot of great work, so part of the goal is to help communicate best practices for that work. Thanks!

tstoeckler’s picture

What you call "communicating" is what I would call "scaring people off". Anyway, you're the boss. Unsubscribe.

benjifisher’s picture

Title: ReplicaDatabaseIgnoreSubscriber mentions non-existant function » ReplicaDatabaseIgnoreSubscriber mentions non-existent function
Issue summary: View changes

I added #2488440: Reformat comments to 80 characters in ReplicaDatabaseIgnoreSubscriber::checkReplicaServer() comments as a follow-up to deal with wrapping the comments to 80 characters. I also edited the summary, crossing out the suggestion to do that as part of this issue. (I did not completely delete it, since that would make earlier comments confusing.)

I think that if we stick to the change recommended in #3, then this still deserves the Novice tag.

jcandan’s picture

Issue tags: -Novice

I am removing the Novice tag from this issue because it's lacking consensus on the issue of splitting it.

I’m using this documentation as a source: https://www.drupal.org/core-mentoring/novice-tasks#avoid

benjifisher’s picture

Priority: Normal » Minor
Issue summary: View changes
FileSize
942 bytes

@jcandan: Not every disagreement counts as lack of consensus. IMHO, if two people disagree and one of them decides to stop following the issue, then the next step is clear.

The attached patch fixes just the problem described in the title, as requested in #3.

I reviewed https://www.drupal.org/core/issue-category and decided that this issue is a bug, not a task: "Incorrect or misleading documentation" is one of the examples of a bug.

I reviewed https://www.drupal.org/core/issue-priority and decided to classify this as "minor". It is pretty close to the example of a minor bug: "An incorrect class reference only in a comment."

benjifisher’s picture

Status: Needs work » Needs review
mgifford’s picture

Re-uploading patch for the bots.

Version: 8.0.x-dev » 8.1.x-dev

Drupal 8.0.6 was released on April 6 and is the final bugfix release for the Drupal 8.0.x series. Drupal 8.0.x will not receive any further development aside from security fixes. Drupal 8.1.0-rc1 is now available and sites should prepare to update to 8.1.0.

Bug reports should be targeted against the 8.1.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.9 was released on September 7 and is the final bugfix release for the Drupal 8.1.x series. Drupal 8.1.x will not receive any further development aside from security fixes. Drupal 8.2.0-rc1 is now available and sites should prepare to upgrade to 8.2.0.

Bug reports should be targeted against the 8.2.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.6 was released on February 1, 2017 and is the final full bugfix release for the Drupal 8.2.x series. Drupal 8.2.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.3.0 on April 5, 2017. (Drupal 8.3.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.3.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.6 was released on August 2, 2017 and is the final full bugfix release for the Drupal 8.3.x series. Drupal 8.3.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.4.0 on October 4, 2017. (Drupal 8.4.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.4.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.4 was released on January 3, 2018 and is the final full bugfix release for the Drupal 8.4.x series. Drupal 8.4.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.5.0 on March 7, 2018. (Drupal 8.5.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.5.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.6 was released on August 1, 2018 and is the final bugfix release for the Drupal 8.5.x series. Drupal 8.5.x will not receive any further development aside from security fixes. Sites should prepare to update to 8.6.0 on September 5, 2018. (Drupal 8.6.0-rc1 is available for testing.)

Bug reports should be targeted against the 8.6.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

andypost’s picture

This could be closed in favour of #2286235: Deprecate db_ignore_replica() and convert it to service
Just needs to migrate commit credits

Version: 8.6.x-dev » 8.8.x-dev

Drupal 8.6.x will not receive any further development aside from security fixes. Bug reports should be targeted against the 8.8.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.9.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.7 was released on June 3, 2020 and is the final full bugfix release for the Drupal 8.8.x series. Drupal 8.8.x will not receive any further development aside from security fixes. Sites should prepare to update to Drupal 8.9.0 or Drupal 9.0.0 for ongoing support.

Bug reports should be targeted against the 8.9.x-dev branch from now on, and new development or disruptive changes should be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.2.x-dev

Drupal 8 is end-of-life as of November 17, 2021. There will not be further changes made to Drupal 8. Bugfixes are now made to the 9.3.x and higher branches only. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.15 was released on June 1st, 2022 and is the final full bugfix release for the Drupal 9.3.x series. Drupal 9.3.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.4.x-dev branch from now on, and new development or disruptive changes should be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.9 was released on December 7, 2022 and is the final full bugfix release for the Drupal 9.4.x series. Drupal 9.4.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.5.x-dev branch from now on, and new development or disruptive changes should be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

needs-review-queue-bot’s picture

Status: Needs review » Needs work
FileSize
133 bytes

The Needs Review Queue Bot tested this issue. It either no longer applies to Drupal core, or fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

Apart from a re-roll or rebase, this issue may need more work to address feedback in the issue or MR comments. To progress an issue, incorporate this feedback as part of the process of updating the issue. This helps other contributors to know what is outstanding.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

Version: 9.5.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.