After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 629868 - add "do not edit" to settings.py
add "do not edit" to settings.py
Status: RESOLVED FIXED
Product: snowy
Classification: Deprecated
Component: general
git master
Other Linux
: Normal minor
: future
Assigned To: snowy-maint
snowy-maint
Depends on:
Blocks:
 
 
Reported: 2010-09-16 18:13 UTC by Michael Volz
Modified: 2010-10-22 14:43 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
self explanitory (872 bytes, patch)
2010-10-22 01:21 UTC, Jeff Schroeder
accepted-commit_now Details | Review

Description Michael Volz 2010-09-16 18:13:20 UTC
For clearer understanding it would be helpful to state at the beginning of settings.py that users should place their settings in local_settings.py instead. One could also make INSTALL clearer on that: "Edit your local_settings.py, but leave settings.py"
Comment 1 Ray Wang 2010-09-17 16:59:51 UTC
Hi Michael, 

From the INSTALL file, there is already a line said, 
"""
2. Set up your local settings file (in your snowy git checkout):
        cp local_settings.py.in local_settings.py
"""

I guess it will probably guide users to use local_settings.py instead of settings.py. Do you mean by just updating comments ahead of INSTALL file or something? :)
Comment 2 Sandy Armstrong 2010-09-17 17:27:15 UTC
Yeah, we discussed this in IRC a bit.  We should be more clear about not editing settings.py in INSTALL, and we should add some comments to settings.py indicating that local_settings.py should be edited instead.
Comment 3 Jeff Schroeder 2010-10-22 01:21:21 UTC
Created attachment 172969 [details] [review]
self explanitory
Comment 4 Sandy Armstrong 2010-10-22 01:36:00 UTC
Review of attachment 172969 [details] [review]:

Lovely
Comment 5 Michael Volz 2010-10-22 14:43:18 UTC
:)