Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
In my quest to learn more about Drupal 7, I found several errors in the instructions to use a PostgreSQL database for Drupal. The fixes include omitted words, wrong indentation, word wrapping, punctuation and grammar.
Comments
Comment #1
jhodgdonThanks! If you're going to do a cleanup, let's get it really clean. It looks good, but there are a few more items:
- e.g. should always be followed by a comma (it means "for example").
- Our standard for Drupal doc is that in lists, the final "and" should be preceded by a comma:
a, b, and c
There's one needed comma for this in the last paragraph of your patch.
- Can you tell me what this means:
You'll need to execute the SQL below as a superuser (such as a postgres user)
How is any old postgres user necessairly a superuser? Does this make sense to you?
Comment #2
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedThanks for the corrections. Learned two new things.
As for the sentence about the superuser, I think you are right that it is not worded correctly. I'm not very familiar with PostgreSQL, but it must be possible to have PostgreSQL users that are not superusers. In my opinion, the parenthesized text can be omitted. An example can be very helpful, but not when it's wrong. I'm not familiar enough with PostgreSQL to come up with an alternative, but I don't think it's necessary to supply an example, as it's pretty self-explanatory that one needs the correct permissions to create a schema. "You'll need to execute the SQL below as a superuser" insinuates this.
The updated patch corrects the aforementioned errors and removes the parenthesized text.
Comment #3
jhodgdonI think you forgot to do what you said about the postgres thing (which I thought was a reasonable suggestion):
Comment #4
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedForgot to remove the parenthesized text. This patch is the correct one. Note to self: Writing about it != writing it.
Comment #5
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedAh, there we go, you caught it before me.
Comment #6
jhodgdonThat looks better. :) One more thing I just noticed: do you think the 'drupaluser' in the schema section should be replaced by 'username', since that is what is used in the examples above? Other than that I am fine with this going in.
Comment #7
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedI actually thought the same before, so that probably means it's the right choice, as we are two who think this independently. I didn't change it because I thought there was some difference between the username used in the 'Create database user' step in the documentation, and the username mentioned in the 'Create schema' step. As I see now this will obviously be the same user. So, I also think that it's best practice to use the same name for the "placeholders". Patch changed :)
Comment #8
jhodgdonThanks! Now it's good to go.
Comment #9
webchickIf we're going to clean these up in INSTALL.pgsql.txt, it makes sense to make all of the various files consistent.
For example, you've added commas here and there and stuff like that which are not reflected in INSTALL.mysql.txt even though the text is mostly the same.
Comment #10
jhodgdonOK. Probably should take a look at INSTALL.sqlite.text too.
Comment #11
Tor Arne Thune CreditAttribution: Tor Arne Thune commentedInstall.mysql.txt cleanup for consistency:
I couldn't find anything to change for INSTALL.sqlite.txt.
Comment #12
jhodgdonAgreed, I don't see anything else that needs attention in the mysql or sqlite files. This looks good. Thanks!
Comment #13
Dries CreditAttribution: Dries commentedCommitted to CVS HEAD. Thanks.