In UPGRADE.txt, the explanation of the minor version updates process says that an update sometimes includes changes to settings.php. As far as I know, Drupal does not include settings.php (only default.settings.php), and will not update this file, because it has been created by the user, not the Drupal installation.
The attached patch removes this explanation.
Correct me if I'm wrong.
Comments
Comment #1
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedComment #2
jhodgdonGood point, but this is not the right patch.
It should say that a minor version update might include changes to default.settings.php, and you should replace your settings.php with the new default.settings.php and copy in the changes.
Comment #3
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedAh yes, that would work better, thank you. Attached patch tries to explain this without many changes to the original text.
Comment #4
jhodgdonThat looks good to me! Thanks!
Comment #5
webchickI got a bit turned around in this sentence. :) Is there a way to word this in a less confusing way? For example, giving people specific steps to follow in this instance?
Comment #6
jhodgdonHow about something like this:
If that's the case, follow these steps:
1) Make a backup copy of your settings.php file, with a different file name.
2) Make a copy of the new default.settings.php file, and name the copy settings.php (overwriting your previous settings.php file).
3) Copy the custom and site-specific entries from the backup you made into the new settings.php file. You will definitely need the lines giving the database information, and you will also want to copy in any other customizations you have added.
(This should be formatted appropriately for the rest of the file -- probably 1. rather than 1), or maybe bullet points with - ?)
Comment #7
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedThe suggested change by jhodgdon sounds good to me. It definitely makes it less confusing and more easy on the eyes/brain.
I added the points as - bullet points, because I think it makes the text easier to read, as more numbers can make it more heavy at first glance. It's also done further down in the document. I also added a line of spacing between the bullet points, because I see this was down elsewhere in the document. I'm not sure if this is overkill or not.
Comment #8
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedComment #9
jhodgdonWorks for me, thanks!
Comment #10
Dries CreditAttribution: Dries commentedCan't we:
1. Always recommend people to make a backup of their settings file?
2. Recommend people to read the release announcement as it might have special instructions?
Comment #11
jhodgdonRE #10 - I'm maybe not sure what you're asking.
- Drupal downloads do not overwrite the settings.php file
- I think we already recommend that people make a backup of their db and files in general before they start
- I think we need these specific instructions on how to merge in a new default.settings.php - and the previous instructions were confusing.
So what I think I'm getting from #10 is that we should somewhere recommend that people always check the release announcement to see if there are any special instructions for upgrading to this version. And I think maybe we should clarify when we say that what the "release announcement" is and where to find it (i.e. if you are on the Drupal project page the link is I think "Notes").
Comment #12
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedThis patch has also been updated with the newest HEAD, after #1029346: INSTALL.txt and UPGRADE.txt should mention that you can download Drupal as a .zip file also was committed.
I'm not sure I follow your comment in #10.
Comment #13
jhodgdonsee #11 then. I didn't quite get #10 either. :)
Comment #14
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedOkay, I think I follow now. People should definitely be encouraged to read the release announcement before upgrading. It does seem strange that it's not mentioned in the document (in a general upgrade sense), so the attached patch tries to add some heads-up for the release announcement. I'm not sure it's worded correctly, so please, chime in :)
Comment #15
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedComment #16
jhodgdonSince the link on the project page is called "Notes", maybe we should refer to it as "the release notes" rather than "the release announcement"? If we call it "announcement", it could be confused with a d.o front page post announcing the release, which is not as important for them to read I think, and is not the node we are pointing out the link to.
Suggestion for the first added paragraph:
Each new release of Drupal has release notes, which explain the changes made since the previous version and any special instructions needed to update or upgrade to the new version. You can find a link to the release notes in the Downloads section of the Drupal project page (http://drupal.org/project/drupal), in the Links column for the version you are upgrading or updating to.
Then down below I would refer to this as release notes as well.
Comment #17
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedI was hoping you would change the wording :) It sounds much better now, and I agree about the change from announcement to notes. I did a search for release announcement, and no other files use these words, so I think we are good, as it will be consistent in Drupal core.
Comment #18
jhodgdonThis looks good to me.
Comment #19
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedIt would be great to get this in before the 8.x branch is created, as one step is plain-out wrong.
Comment #20
jhodgdon#17: 1040810-UPGRADE-minor-version-updates-step-7.patch queued for re-testing.
Comment #21
jhodgdonNeeds to go to d8 and then d7
Comment #22
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedCreated D7 and D8 versions of the patch in #17 using Git. Just to try out patch creation in Git and hopefully get this committed.
The patches are identical and make the same changes as the one in #17.
Comment #23
webchickHm. I'm actually hesitant to put quite that much detail in how to get to the release notes. It's fully possible we want to revamp that UI at some point down the road, and we're almost certain to forget to change it here. Is it possible to vague that up a little bit?
Comment #24
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedI see your point and agree. In the new patches I have tried to rephrase this to be a bit less specific to the location of the link, but I feel it would be too much to remove the mention of where to find the release notes on Drupal.org entirely, as well as remove the link. I know personally that they can be a little difficult to find when starting out, as the location varies between communities. The link to the release notes on the Drupal project page reads "Notes," which could be missed as being the "release notes," but to further specify that the link reading "Notes" is the link to the "release notes" is a bit overkill. "Seek and you shall find" ;)
Comment #25
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedComment #27
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedAh, I get it. The D7 patch will fail no matter what because the testbot tries to apply it to the 8.x branch. I should not have called it *D7-2.patch, but rather *D7.patch. Sorry for wasting resources!
Comment #28
jhodgdonThe patches in #24 look good to me. Good idea webchick to make the instructions a bit less specific.
Comment #29
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedGreat, all concerns and suggestions are in the patch and ready to go :)
Comment #30
xjmTagging issues not yet using summary template.
Comment #31
jhodgdon#24: 1040810-UPGRADE-minor-version-updates-step-D8-2.patch queued for re-testing.
Comment #32
jhodgdonThis has been sitting around for a while, so re-testing.
Comment #33
catchThe less specific text looks good to me too. Committed to 8.x, back to 7.x for webchick to consider.
Comment #34
webchickLooks good. Sorry, no idea how that fell off my radar for so long!
Committed and pushed to 7.x. Thanks!