Added quoting for passwords in sample.app.ini and documentation #3395
Conversation
tboerger
added
the
lgtm/need 1
Codecov Report
@@ Coverage Diff @@
## master #3395 +/- ##
==========================================
+ Coverage 35.6% 35.61% +<.01%
==========================================
Files 281 281
Lines 40586 40586
==========================================
+ Hits 14451 14453 +2
+ Misses 23996 23994 -2
Partials 2139 2139
Continue to review full report at Codecov.
|
| @@ -118,7 +118,7 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`. | |||
| - `HOST`: **127.0.0.1:3306**: Database host address and port. | |||
| - `NAME`: **gitea**: Database name. | |||
| - `USER`: **root**: Database username. | |||
| - `PASSWD`: **\<empty\>**: Database user password. | |||
| - `PASSWD`: **\`\<empty\>\`**: Database user password. Use \`your password\` for quoting, if you use special characters in the password. | |||
There was a problem hiding this comment.
It doesn't look correct to quote <empty> ...
| @@ -185,7 +185,7 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`. | |||
| - `FROM`: **\<empty\>**: Mail from address, RFC 5322. This can be just an email address, or | |||
| the "Name" \<email@example.com\> format. | |||
| - `USER`: **\<empty\>**: Username of mailing user (usually the sender's e-mail address). | |||
| - `PASSWD`: **\<empty\>**: Password of mailing user. | |||
| - `PASSWD`: **\`\<empty\>\`**: Password of mailing user. Use \`your password\` for quoting, if you use special characters in the password. | |||
There was a problem hiding this comment.
quoting <empty> is unlikely correct, it's not a password, is an indication to the user that there's NOTHING written as a password...
There was a problem hiding this comment.
Thank you for this hint. Should be also enough to just write it in the comment. Backtick schould be the right quotation and works for both.
|
I've removed the quotations from as suggested. Now it is only in the comment. |
|
Classic german comma before the dependent clause ;) But I'm not gonna nitpick to that, because that's an incredibly minor issue and the sentence still works. LGTM |
tboerger
added
lgtm/done
This pull request is addressing issue #3380.
I've added quote hints in sample.app.ini and it's documentation, preventing wrong behavior when parsing the file if special characters are used in passwords.
Without quotes the password will be read wrong.