From 5489fc47df76c3f25a959510b885fa9a28b495b4 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Mon, 24 Dec 2012 15:37:36 -0500 Subject: [PATCH] [1.5.X] Fixed links to DATABASE ENGINE setting. refs #19516 Backport of f56f6cfa58 from master --- docs/howto/initial-data.txt | 4 ++-- docs/howto/legacy-databases.txt | 2 +- docs/intro/tutorial01.txt | 7 ++++--- docs/releases/0.96.txt | 5 ++--- docs/releases/1.0-porting-guide.txt | 3 +-- docs/releases/1.2-alpha-1.txt | 20 ++++++++++---------- docs/releases/1.2.txt | 22 +++++++++++----------- docs/topics/testing/overview.txt | 6 +++--- 8 files changed, 34 insertions(+), 35 deletions(-) diff --git a/docs/howto/initial-data.txt b/docs/howto/initial-data.txt index eca2e2c4f9..cea07bfea3 100644 --- a/docs/howto/initial-data.txt +++ b/docs/howto/initial-data.txt @@ -153,8 +153,8 @@ each app, Django looks for a file called ``/sql/..sql``, where ```` is your app directory, ```` is the model's name in lowercase and ```` is the last part of the module name provided for the -:setting:`ENGINE` in your settings file (e.g., if you have defined a -database with an :setting:`ENGINE` value of +:setting:`ENGINE ` in your settings file (e.g., if you have +defined a database with an :setting:`ENGINE ` value of ``django.db.backends.sqlite3``, Django will look for ``/sql/.sqlite3.sql``). diff --git a/docs/howto/legacy-databases.txt b/docs/howto/legacy-databases.txt index 1b04e6d77c..3e75ef1e5f 100644 --- a/docs/howto/legacy-databases.txt +++ b/docs/howto/legacy-databases.txt @@ -21,7 +21,7 @@ setting and assigning values to the following keys for the ``'default'`` connection: * :setting:`NAME` -* :setting:`ENGINE` +* :setting:`ENGINE ` * :setting:`USER` * :setting:`PASSWORD` * :setting:`HOST` diff --git a/docs/intro/tutorial01.txt b/docs/intro/tutorial01.txt index 9419f9c4eb..ab6c8b999f 100644 --- a/docs/intro/tutorial01.txt +++ b/docs/intro/tutorial01.txt @@ -207,9 +207,10 @@ your database connection settings. same physical machine (not used for SQLite). See :setting:`HOST` for details. If you're new to databases, we recommend simply using SQLite by setting -:setting:`ENGINE` to ``'django.db.backends.sqlite3'`` and :setting:`NAME` to -the place where you'd like to store the database. SQLite is included in Python, -so you won't need to install anything else to support your database. +:setting:`ENGINE ` to ``'django.db.backends.sqlite3'`` and +:setting:`NAME` to the place where you'd like to store the database. SQLite is +included in Python, so you won't need to install anything else to support your +database. .. note:: diff --git a/docs/releases/0.96.txt b/docs/releases/0.96.txt index a00f878df3..bbec1c3eaf 100644 --- a/docs/releases/0.96.txt +++ b/docs/releases/0.96.txt @@ -34,8 +34,7 @@ exceptions if you attempt to use an older version. If you're currently unable to upgrade your copy of ``MySQLdb`` to meet this requirement, a separate, backwards-compatible backend, called "mysql_old", has been added to Django. To use this backend, change -the :setting:`DATABASE_ENGINE` setting in your Django settings file from -this:: +the ``DATABASE_ENGINE`` setting in your Django settings file from this:: DATABASE_ENGINE = "mysql" @@ -49,7 +48,7 @@ provided only to ease this transition, and is considered deprecated; aside from any necessary security fixes, it will not be actively maintained, and it will be removed in a future release of Django. -Also, note that some features, like the new :setting:`DATABASE_OPTIONS` +Also, note that some features, like the new ``DATABASE_OPTIONS`` setting (see the :doc:`databases documentation ` for details), are only available on the "mysql" backend, and will not be made available for "mysql_old". diff --git a/docs/releases/1.0-porting-guide.txt b/docs/releases/1.0-porting-guide.txt index 29e40b2ebe..78bc7acb98 100644 --- a/docs/releases/1.0-porting-guide.txt +++ b/docs/releases/1.0-porting-guide.txt @@ -548,7 +548,7 @@ need to reload your data. Do this after you have made the change to using **Back up your database first!** For SQLite, this means making a copy of the single file that stores the - database (the name of that file is the :setting:`DATABASE_NAME` in your + database (the name of that file is the ``DATABASE_NAME`` in your settings.py file). To upgrade each application to use a ``DecimalField``, you can do the @@ -769,4 +769,3 @@ Old (0.96) New (1.0) ``backend.uses_case_insensitive_names`` ``connection.features.uses_case_insensitive_names`` ``backend.uses_custom_queryset`` ``connection.features.uses_custom_queryset`` ======================================= =================================================== - diff --git a/docs/releases/1.2-alpha-1.txt b/docs/releases/1.2-alpha-1.txt index 5a8f8fc5f5..16e1940e8f 100644 --- a/docs/releases/1.2-alpha-1.txt +++ b/docs/releases/1.2-alpha-1.txt @@ -285,16 +285,16 @@ This affects the following settings: ========================================= ========================== Old setting New Setting ========================================= ========================== -:setting:`DATABASE_ENGINE` :setting:`ENGINE` -:setting:`DATABASE_HOST` :setting:`HOST` -:setting:`DATABASE_NAME` :setting:`NAME` -:setting:`DATABASE_OPTIONS` :setting:`OPTIONS` -:setting:`DATABASE_PASSWORD` :setting:`PASSWORD` -:setting:`DATABASE_PORT` :setting:`PORT` -:setting:`DATABASE_USER` :setting:`USER` -:setting:`TEST_DATABASE_CHARSET` :setting:`TEST_CHARSET` -:setting:`TEST_DATABASE_COLLATION` :setting:`TEST_COLLATION` -:setting:`TEST_DATABASE_NAME` :setting:`TEST_NAME` +`DATABASE_ENGINE` :setting:`ENGINE ` +`DATABASE_HOST` :setting:`HOST` +`DATABASE_NAME` :setting:`NAME` +`DATABASE_OPTIONS` :setting:`OPTIONS` +`DATABASE_PASSWORD` :setting:`PASSWORD` +`DATABASE_PORT` :setting:`PORT` +`DATABASE_USER` :setting:`USER` +`TEST_DATABASE_CHARSET` :setting:`TEST_CHARSET` +`TEST_DATABASE_COLLATION` :setting:`TEST_COLLATION` +`TEST_DATABASE_NAME` :setting:`TEST_NAME` ========================================= ========================== These changes are also required if you have manually created a database diff --git a/docs/releases/1.2.txt b/docs/releases/1.2.txt index 334f9eb94b..26a9405595 100644 --- a/docs/releases/1.2.txt +++ b/docs/releases/1.2.txt @@ -819,16 +819,16 @@ This affects the following settings: ========================================= ========================== Old setting New Setting ========================================= ========================== -:setting:`DATABASE_ENGINE` :setting:`ENGINE` -:setting:`DATABASE_HOST` :setting:`HOST` -:setting:`DATABASE_NAME` :setting:`NAME` -:setting:`DATABASE_OPTIONS` :setting:`OPTIONS` -:setting:`DATABASE_PASSWORD` :setting:`PASSWORD` -:setting:`DATABASE_PORT` :setting:`PORT` -:setting:`DATABASE_USER` :setting:`USER` -:setting:`TEST_DATABASE_CHARSET` :setting:`TEST_CHARSET` -:setting:`TEST_DATABASE_COLLATION` :setting:`TEST_COLLATION` -:setting:`TEST_DATABASE_NAME` :setting:`TEST_NAME` +`DATABASE_ENGINE` :setting:`ENGINE ` +`DATABASE_HOST` :setting:`HOST` +`DATABASE_NAME` :setting:`NAME` +`DATABASE_OPTIONS` :setting:`OPTIONS` +`DATABASE_PASSWORD` :setting:`PASSWORD` +`DATABASE_PORT` :setting:`PORT` +`DATABASE_USER` :setting:`USER` +`TEST_DATABASE_CHARSET` :setting:`TEST_CHARSET` +`TEST_DATABASE_COLLATION` :setting:`TEST_COLLATION` +`TEST_DATABASE_NAME` :setting:`TEST_NAME` ========================================= ========================== These changes are also required if you have manually created a database @@ -850,7 +850,7 @@ has been deprecated. If you are currently using the ``postgresql`` backend, you should migrate to using the ``postgresql_psycopg2`` backend. To update your code, install the ``psycopg2`` library and change the -:setting:`DATABASE_ENGINE` setting to use +:setting:`ENGINE ` setting to use ``django.db.backends.postgresql_psycopg2``. CSRF response-rewriting middleware diff --git a/docs/topics/testing/overview.txt b/docs/topics/testing/overview.txt index a4fc35298c..7b096b420d 100644 --- a/docs/topics/testing/overview.txt +++ b/docs/topics/testing/overview.txt @@ -195,9 +195,9 @@ entirely!). If you want to use a different database name, specify Aside from using a separate database, the test runner will otherwise use all of the same database settings you have in your settings file: -:setting:`ENGINE`, :setting:`USER`, :setting:`HOST`, etc. The test -database is created by the user specified by :setting:`USER`, so you'll need -to make sure that the given user account has sufficient privileges to +:setting:`ENGINE `, :setting:`USER`, :setting:`HOST`, etc. The +test database is created by the user specified by :setting:`USER`, so you'll +need to make sure that the given user account has sufficient privileges to create a new database on the system. For fine-grained control over the character encoding of your test