diff options
| author | Boulder Sprinters <boulder-sprinters@djangoproject.com> | 2007-03-20 16:21:17 +0000 |
|---|---|---|
| committer | Boulder Sprinters <boulder-sprinters@djangoproject.com> | 2007-03-20 16:21:17 +0000 |
| commit | 815837c8af6cb917dabbb3638b2ccf182263866d (patch) | |
| tree | 5ed1c4d8448c2977f8773404effe4360c1f9ae9d /docs | |
| parent | 881c07cf2e212e04b2a8be47f444c6da56b5f382 (diff) | |
boulder-oracle-sprint: Merged to [4754]. 8 tests still fail, although
serializers_regress fails on Postgres as well so it may need a more general fix.
git-svn-id: http://code.djangoproject.com/svn/django/branches/boulder-oracle-sprint@4755 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contributing.txt | 14 | ||||
| -rw-r--r-- | docs/databases.txt | 122 | ||||
| -rw-r--r-- | docs/distributions.txt | 2 | ||||
| -rw-r--r-- | docs/django-admin.txt | 2 | ||||
| -rw-r--r-- | docs/i18n.txt | 14 | ||||
| -rw-r--r-- | docs/model-api.txt | 5 |
6 files changed, 80 insertions, 79 deletions
diff --git a/docs/contributing.txt b/docs/contributing.txt index 8364405775..1d2b635b76 100644 --- a/docs/contributing.txt +++ b/docs/contributing.txt @@ -303,11 +303,11 @@ Please follow these coding standards when writing code for inclusion in Django: def my_view(req, foo): # ... - * Our policy is to keep the names of developers and contributors - in the ``AUTHORS`` file distributed with Django, so please don't include - your name in the actual code. Feel free to include a change to the - ``AUTHORS`` file in your patch if you make more than a single trivial - change. + * Please don't put your name in the code you contribute. Our policy is to + keep contributors' names in the ``AUTHORS`` file distributed with Django + -- not scattered throughout the codebase itself. Feel free to include a + change to the ``AUTHORS`` file in your patch if you make more than a + single trivial change. Committing code =============== @@ -527,12 +527,12 @@ sure all other lines are commented:: # http://code.djangoproject.com/svn/django/trunk/ # /path/to/trunk - + # <branch> is a svn checkout of: # http://code.djangoproject.com/svn/django/branches/<branch>/ # #/path/to/<branch> - + # On windows a path may look like this: # C:/path/to/<branch> diff --git a/docs/databases.txt b/docs/databases.txt index ff6abd7271..3545b58d47 100644 --- a/docs/databases.txt +++ b/docs/databases.txt @@ -1,56 +1,59 @@ =============================== -Notes About Supported Databases +Notes about supported databases =============================== -Django attempts to support as many features as possible on all databases. -However, since not all database servers are identical, there is obviously -going to be some variations. This file describes some of the -features that might relevant to Django usage. It is not intended as a -replacement for server-specific documentation or reference manuals. +Django attempts to support as many features as possible on all database +backends. However, not all database backends are alike, and we've had to make +design decisions on which features to support and which assumptions we can make +safely. -MySQL Notes +This file describes some of the features that might be relevant to Django +usage. Of course, it is not intended as a replacement for server-specific +documentation or reference manuals. + +MySQL notes =========== Django expects the database to support transactions, referential integrity, -and Unicode support (UTF-8 encoding). Fortunately MySQL_ has all these +and Unicode support (UTF-8 encoding). Fortunately, MySQL_ has all these features as available as far back as 3.23. While it may be possible to use -3.23 or 4.0, you will probably have less trouble if you use 4.1 or 5.0. +3.23 or 4.0, you'll probably have less trouble if you use 4.1 or 5.0. -MySQL-4.1 +MySQL 4.1 --------- -MySQL-4.1_ has greatly improved support for character sets. It is possible to +`MySQL 4.1`_ has greatly improved support for character sets. It is possible to set different default character sets on the database, table, and column. Previous versions have only a server-wide character set setting. It's also the first version where the character set can be changed on the fly. 4.1 also has -support for views, but these are not currently used by Django. +support for views, but Django currently doesn't use views. -MySQL-5.0 +MySQL 5.0 --------- -MySQL-5.0_ adds the ``information_schema`` database, which contains detailed -data on all database schema. This is used for Django's ``inspectdb`` feature, -when it is available. 5.0 also has support for stored procedures, but these -are not currently used by Django. +`MySQL 5.0`_ adds the ``information_schema`` database, which contains detailed +data on all database schema. Django's ``inspectdb`` feature uses this +``information_schema`` if it's available. 5.0 also has support for stored +procedures, but Django currently doesn't use stored procedures. .. _MySQL: http://www.mysql.com/ -.. _MySQL-4.1: http://dev.mysql.com/doc/refman/4.1/en/index.html -.. _MySQL-5.0: http://dev.mysql.com/doc/refman/5.0/en/index.html +.. _MySQL 4.1: http://dev.mysql.com/doc/refman/4.1/en/index.html +.. _MySQL 5.0: http://dev.mysql.com/doc/refman/5.0/en/index.html -Storage Engines +Storage engines --------------- MySQL has several `storage engines`_ (previously called table types). You can change the default storage engine in the server configuration. -The default one is MyISAM_. The main drawback of MyISAM is that it does not -currently have support for transactions or foreign keys. On the plus side, it -is currently the only engine that supports full-text indexing and searching. +The default engine is MyISAM_. The main drawback of MyISAM is that it doesn't +currently support transactions or foreign keys. On the plus side, it's +currently the only engine that supports full-text indexing and searching. The InnoDB_ engine is fully transactional and supports foreign key references. The BDB_ engine, like InnoDB, is also fully transactional and supports foreign -key references. However, it's use seems to be somewhat deprecated. +key references. However, its use seems to be deprecated. `Other storage engines`_, including SolidDB_ and Falcon_, are on the horizon. For now, InnoDB is probably your best choice. @@ -66,25 +69,25 @@ For now, InnoDB is probably your best choice. MySQLdb ------- -`MySQLdb`_ is the Python interface to MySQL. 1.2.1 is the first version which -has support for MySQL-4.1 and newer. If you are trying to use an older version -of MySQL, then 1.2.0 *may* work for you. +`MySQLdb`_ is the Python interface to MySQL. 1.2.1 is the first version that +has support for MySQL 4.1 and newer. If you are trying to use an older version +of MySQL, then 1.2.0 *might* work for you. .. _MySQLdb: http://sourceforge.net/projects/mysql-python Creating your database -~~~~~~~~~~~~~~~~~~~~~~ +---------------------- You can `create your database`_ using the command-line tools and this SQL:: CREATE DATABASE <dbname> CHARACTER SET utf8; - -This ensures all tables and columns will use utf8 by default. - + +This ensures all tables and columns will use UTF-8 by default. + .. _create your database: http://dev.mysql.com/doc/refman/5.0/en/create-database.html Connecting to the database -~~~~~~~~~~~~~~~~~~~~~~~~~~ +-------------------------- Refer to the `settings documentation`_. @@ -106,7 +109,7 @@ Here's a sample configuration which uses a MySQL option file:: DATABASE_OPTIONS = { 'read_default_file': '/path/to/my.cnf', } - + # my.cnf [client] database = DATABASE_NAME @@ -114,49 +117,46 @@ Here's a sample configuration which uses a MySQL option file:: passwd = DATABASE_PASSWORD default-character-set = utf8 -There are several other MySQLdb connection options which may be useful, such -as ``ssl``, ``use_unicode``, ``init_command``, and ``sql_mode``; consult the +Several other MySQLdb connection options may be useful, such as ``ssl``, +``use_unicode``, ``init_command``, and ``sql_mode``. Consult the `MySQLdb documentation`_ for more details. - + .. _settings documentation: http://www.djangoproject.com/documentation/settings/#database-engine .. _MySQL option file: http://dev.mysql.com/doc/refman/5.0/en/option-files.html .. _MySQLdb documentation: http://mysql-python.sourceforge.net/ Creating your tables -~~~~~~~~~~~~~~~~~~~~ +-------------------- -When Django generates the schema, it doesn't specify a storage engine, so they -will be created with whatever default `storage engine`__ your database server -is configured for. The easiest solution is to set your database server's default -storage engine to the desired engine. +When Django generates the schema, it doesn't specify a storage engine, so +tables will be created with whatever default storage engine your database +server is configured for. The easiest solution is to set your database server's +default storage engine to the desired engine. -__ `storage engines`_ - -If you are using a hosting service and can't change your server's default +If you're using a hosting service and can't change your server's default storage engine, you have a couple of options. -After the tables is created, all that is needed to convert it to a new storage -engine (such as InnoDB) is:: - - ALTER TABLE <tablename> ENGINE=INNODB; + * After the tables are created, execute an ``ALTER TABLE`` statement to + convert a table to a new storage engine (such as InnoDB):: -With a lot of tables, this can be tedious. + ALTER TABLE <tablename> ENGINE=INNODB; -Another option is to use the ``init_command`` option for MySQLdb prior to -creating your tables:: + This can be tedious if you have a lot of tables. - DATABASE_OPTIONS = { - ... - "init_command": "SET storage_engine=INNODB", - ... - } + * Another option is to use the ``init_command`` option for MySQLdb prior to + creating your tables:: + + DATABASE_OPTIONS = { + # ... + "init_command": "SET storage_engine=INNODB", + # ... + } -This sets the default storage engine upon connecting to the database. After -your tables are set up and running in production, you should remove this -option. + This sets the default storage engine upon connecting to the database. + After your tables have been created, you should remove this option. -Another method for changing the storage engine is described in -AlterModelOnSyncDB_. + * Another method for changing the storage engine is described in + AlterModelOnSyncDB_. .. _AlterModelOnSyncDB: http://code.djangoproject.com/wiki/AlterModelOnSyncDB diff --git a/docs/distributions.txt b/docs/distributions.txt index a77d3a1959..63206c535e 100644 --- a/docs/distributions.txt +++ b/docs/distributions.txt @@ -57,7 +57,7 @@ Gentoo ------ A Django build is available for `Gentoo Linux`_, and is based on Django 0.95.1. -The `current Gentoo build`_ can be installed by typing ``emerge Django``. +The `current Gentoo build`_ can be installed by typing ``emerge django``. .. _Gentoo Linux: http://www.gentoo.org/ .. _current Gentoo build: http://packages.gentoo.org/packages/?category=dev-python;name=django diff --git a/docs/django-admin.txt b/docs/django-admin.txt index 371c44e010..ef1d73cdbd 100644 --- a/docs/django-admin.txt +++ b/docs/django-admin.txt @@ -216,7 +216,7 @@ installation will be aborted, and any data installed in the call to ``loaddata`` will be removed from the database. The fixtures that are named can include directory components. These -directories will be inluded in the search path. For example:: +directories will be included in the search path. For example:: django-admin.py loaddata foo/bar/mydata.json diff --git a/docs/i18n.txt b/docs/i18n.txt index d430a56160..4a05e53ddf 100644 --- a/docs/i18n.txt +++ b/docs/i18n.txt @@ -284,13 +284,13 @@ obtain) the language translations themselves. Here's how that works. .. admonition:: Locale restrictions - Django does not support localising your application into a locale for - which Django itself has not been translated -- it will ignore your - translation files. If you were to try this and Django supported it, you - would inevitably see a mixture of translated strings (from your - application) and English strings (from Django itself). If you are wanting - to support a locale for your application that is not already part of - Django, you will need to make at least a minimal translation of the Django + Django does not support localizing your application into a locale for + which Django itself has not been translated. In this case, it will ignore + your translation files. If you were to try this and Django supported it, + you would inevitably see a mixture of translated strings (from your + application) and English strings (from Django itself). If you want to + support a locale for your application that is not already part of + Django, you'll need to make at least a minimal translation of the Django core. Message files diff --git a/docs/model-api.txt b/docs/model-api.txt index e66e96de68..26686b02fe 100644 --- a/docs/model-api.txt +++ b/docs/model-api.txt @@ -1216,8 +1216,9 @@ screen via ``<script src="">`` tags. This can be used to tweak a given type of admin page in JavaScript or to provide "quick links" to fill in default values for certain fields. -If relative URLs are used, Django admin will automatically prepend these links -with ``settings.ADMIN_MEDIA_PREFIX``. +If you use relative URLs -- URLs that don't start with ``http://`` or ``/`` -- +then the admin site will automatically prefix these links with +``settings.ADMIN_MEDIA_PREFIX``. ``list_display`` ---------------- |
