Ticket #13727: alpha-use-settings.2.diff

File alpha-use-settings.2.diff, 6.0 KB (added by Adam Vandenberg, 15 years ago)

While I'm at it, alphabetize some more settings too.

  • docs/ref/settings.txt 

    diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt
index 958ac88..5943f1a 100644
    a b Default: ``600``  
    152152The default number of seconds to cache a page when the caching middleware or
    153153``cache_page()`` decorator is used.
    154154
    155 .. setting:: CSRF_COOKIE_NAME
    156 
    157 CSRF_COOKIE_NAME
    158 ----------------
    159 
    160 .. versionadded:: 1.2
    161 
    162 Default: ``'csrftoken'``
    163 
    164 The name of the cookie to use for the CSRF authentication token. This can be whatever you
    165 want.  See :ref:`ref-contrib-csrf`.
    166 
    167155.. setting:: CSRF_COOKIE_DOMAIN
    168156
    169157CSRF_COOKIE_DOMAIN
    … … request forgery protection. It should be set to a string such as  
    179167``".lawrence.com"`` to allow a POST request from a form on one subdomain to be
    180168accepted by accepted by a view served from another subdomain.
    181169
     170.. setting:: CSRF_COOKIE_NAME
     171
     172CSRF_COOKIE_NAME
     173----------------
     174
     175.. versionadded:: 1.2
     176
     177Default: ``'csrftoken'``
     178
     179The name of the cookie to use for the CSRF authentication token. This can be whatever you
     180want.  See :ref:`ref-contrib-csrf`.
     181
    182182.. setting:: CSRF_FAILURE_VIEW
    183183
    184184CSRF_FAILURE_VIEW
    … … Default: ``'webmaster@localhost'``  
    573573Default e-mail address to use for various automated correspondence from the
    574574site manager(s).
    575575
    576 .. setting:: DEFAULT_TABLESPACE
     576.. setting:: DEFAULT_INDEX_TABLESPACE
    577577
    578 DEFAULT_TABLESPACE
    579 ------------------
     578DEFAULT_INDEX_TABLESPACE
     579------------------------
    580580
    581581.. versionadded:: 1.0
    582582
    583583Default: ``''`` (Empty string)
    584584
    585 Default tablespace to use for models that don't specify one, if the
    586 backend supports it.
     585Default tablespace to use for indexes on fields that don't specify
     586one, if the backend supports it.
    587587
    588 .. setting:: DEFAULT_INDEX_TABLESPACE
     588.. setting:: DEFAULT_TABLESPACE
    589589
    590 DEFAULT_INDEX_TABLESPACE
    591 ------------------------
     590DEFAULT_TABLESPACE
     591------------------
    592592
    593593.. versionadded:: 1.0
    594594
    595595Default: ``''`` (Empty string)
    596596
    597 Default tablespace to use for indexes on fields that don't specify
    598 one, if the backend supports it.
     597Default tablespace to use for models that don't specify one, if the
     598backend supports it.
    599599
    600600.. setting:: DISALLOWED_USER_AGENTS
    601601
    … … Default: ``2621440`` (i.e. 2.5 MB).  
    738738The maximum size (in bytes) that an upload will be before it gets streamed to
    739739the file system. See :ref:`topics-files` for details.
    740740
    741 .. setting:: FILE_UPLOAD_TEMP_DIR
    742 
    743 FILE_UPLOAD_TEMP_DIR
    744 --------------------
    745 
    746 .. versionadded:: 1.0
    747 
    748 Default: ``None``
    749 
    750 The directory to store data temporarily while uploading files. If ``None``,
    751 Django will use the standard temporary directory for the operating system. For
    752 example, this will default to '/tmp' on \*nix-style operating systems.
    753 
    754 See :ref:`topics-files` for details.
    755 
    756741.. setting:: FILE_UPLOAD_PERMISSIONS
    757742
    758743FILE_UPLOAD_PERMISSIONS
    … … system's standard umask.  
    781766
    782767.. _documentation for os.chmod: http://docs.python.org/library/os.html#os.chmod
    783768
     769.. setting:: FILE_UPLOAD_TEMP_DIR
     770
     771FILE_UPLOAD_TEMP_DIR
     772--------------------
     773
     774.. versionadded:: 1.0
     775
     776Default: ``None``
     777
     778The directory to store data temporarily while uploading files. If ``None``,
     779Django will use the standard temporary directory for the operating system. For
     780example, this will default to '/tmp' on \*nix-style operating systems.
     781
     782See :ref:`topics-files` for details.
     783
    784784.. setting:: FIRST_DAY_OF_WEEK
    785785
    786786FIRST_DAY_OF_WEEK
    … … Default: ``'root@localhost'``  
    12271227The e-mail address that error messages come from, such as those sent to
    12281228``ADMINS`` and ``MANAGERS``.
    12291229
    1230 .. setting:: SESSION_ENGINE
    1231 
    1232 SESSION_ENGINE
    1233 --------------
    1234 
    1235 .. versionadded:: 1.0
    1236 
    1237 .. versionchanged:: 1.1
    1238    The ``cached_db`` backend was added
    1239 
    1240 Default: ``django.contrib.sessions.backends.db``
    1241 
    1242 Controls where Django stores session data. Valid values are:
    1243 
    1244     * ``'django.contrib.sessions.backends.db'``
    1245     * ``'django.contrib.sessions.backends.file'``
    1246     * ``'django.contrib.sessions.backends.cache'``
    1247     * ``'django.contrib.sessions.backends.cached_db'``
    1248 
    1249 See :ref:`topics-http-sessions`.
    1250 
    12511230.. setting:: SESSION_COOKIE_AGE
    12521231
    12531232SESSION_COOKIE_AGE
    … … Whether to use a secure cookie for the session cookie. If this is set to  
    13061285ensure that the cookie is only sent under an HTTPS connection.
    13071286See the :ref:`topics-http-sessions`.
    13081287
     1288.. setting:: SESSION_ENGINE
     1289
     1290SESSION_ENGINE
     1291--------------
     1292
     1293.. versionadded:: 1.0
     1294
     1295.. versionchanged:: 1.1
     1296   The ``cached_db`` backend was added
     1297
     1298Default: ``django.contrib.sessions.backends.db``
     1299
     1300Controls where Django stores session data. Valid values are:
     1301
     1302    * ``'django.contrib.sessions.backends.db'``
     1303    * ``'django.contrib.sessions.backends.file'``
     1304    * ``'django.contrib.sessions.backends.cache'``
     1305    * ``'django.contrib.sessions.backends.cached_db'``
     1306
     1307See :ref:`topics-http-sessions`.
     1308
    13091309.. setting:: SESSION_EXPIRE_AT_BROWSER_CLOSE
    13101310
    13111311SESSION_EXPIRE_AT_BROWSER_CLOSE
    … … A boolean that specifies whether to output the "Etag" header. This saves  
    16011601bandwidth but slows down performance. This is only used if ``CommonMiddleware``
    16021602is installed (see :ref:`topics-http-middleware`).
    16031603
     1604.. setting:: USE_I18N
     1605
     1606USE_I18N
     1607--------
     1608
     1609Default: ``True``
     1610
     1611A boolean that specifies whether Django's internationalization system should be
     1612enabled. This provides an easy way to turn it off, for performance. If this is
     1613set to ``False``, Django will make some optimizations so as not to load the
     1614internationalization machinery.
     1615
     1616See also ``USE_L10N``
     1617
    16041618.. setting:: USE_L10N
    16051619
    16061620USE_L10N
    … … format of the current locale.  
    16161630
    16171631See also ``USE_I18N`` and ``LANGUAGE_CODE``
    16181632
    1619 .. setting:: USE_I18N
    1620 
    1621 USE_I18N
    1622 --------
    1623 
    1624 Default: ``True``
    1625 
    1626 A boolean that specifies whether Django's internationalization system should be
    1627 enabled. This provides an easy way to turn it off, for performance. If this is
    1628 set to ``False``, Django will make some optimizations so as not to load the
    1629 internationalization machinery.
    1630 
    1631 See also ``USE_L10N``
    1632 
    16331633.. setting:: USE_THOUSAND_SEPARATOR
    16341634
    16351635USE_THOUSAND_SEPARATOR
Back to Top