diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/howto/custom-management-commands.txt | 4 | ||||
| -rw-r--r-- | docs/howto/initial-data.txt | 4 | ||||
| -rw-r--r-- | docs/man/django-admin.1 | 24 | ||||
| -rw-r--r-- | docs/ref/contrib/admin/admindocs.txt | 4 | ||||
| -rw-r--r-- | docs/ref/django-admin.txt | 72 | ||||
| -rw-r--r-- | docs/topics/migrations.txt | 2 |
6 files changed, 55 insertions, 55 deletions
diff --git a/docs/howto/custom-management-commands.txt b/docs/howto/custom-management-commands.txt index 4f95838760..b5d461e2ce 100644 --- a/docs/howto/custom-management-commands.txt +++ b/docs/howto/custom-management-commands.txt @@ -199,8 +199,8 @@ All attributes can be set in your derived class and can be used in A string listing the arguments accepted by the command, suitable for use in help messages; e.g., a command which takes - a list of application names might set this to '<appname - appname ...>'. + a list of application names might set this to '<app_label + app_label ...>'. .. attribute:: BaseCommand.can_import_settings diff --git a/docs/howto/initial-data.txt b/docs/howto/initial-data.txt index 61885a0803..d003db6497 100644 --- a/docs/howto/initial-data.txt +++ b/docs/howto/initial-data.txt @@ -150,13 +150,13 @@ Database-backend-specific SQL data There's also a hook for backend-specific SQL data. For example, you can have separate initial-data files for PostgreSQL and SQLite. For each app, Django looks for a file called -``<appname>/sql/<modelname>.<backend>.sql``, where ``<appname>`` is +``<app_label>/sql/<modelname>.<backend>.sql``, where ``<app_label>`` is your app directory, ``<modelname>`` is the model's name in lowercase and ``<backend>`` is the last part of the module name provided for the :setting:`ENGINE <DATABASE-ENGINE>` in your settings file (e.g., if you have defined a database with an :setting:`ENGINE <DATABASE-ENGINE>` value of ``django.db.backends.sqlite3``, Django will look for -``<appname>/sql/<modelname>.sqlite3.sql``). +``<app_label>/sql/<modelname>.sqlite3.sql``). Backend-specific SQL data is executed before non-backend-specific SQL data. For example, if your app contains the files ``sql/person.sql`` diff --git a/docs/man/django-admin.1 b/docs/man/django-admin.1 index c72c3520b5..c9932ac36f 100644 --- a/docs/man/django-admin.1 +++ b/docs/man/django-admin.1 @@ -40,7 +40,7 @@ Displays differences between the current and Django's default settings. Settings that don't appear in the defaults are followed by "###". .TP -.BI "dumpdata [" "\-\-all" "] [" "\-\-format=FMT" "] [" "\-\-indent=NUM" "] [" "\-\-natural=NATURAL" "] [" "appname appname appname.Model ..." "]" +.BI "dumpdata [" "\-\-all" "] [" "\-\-format=FMT" "] [" "\-\-indent=NUM" "] [" "\-\-natural=NATURAL" "] [" "app_label app_label app_label.Model ..." "]" Outputs to standard output all data in the database associated with the named application(s). .TP @@ -54,7 +54,7 @@ model module. .BI "loaddata [" "fixture fixture ..." "]" Searches for and loads the contents of the named fixture into the database. .TP -.BI "install [" "appname ..." "]" +.BI "install [" "app_label ..." "]" Executes .B sqlall for the given app(s) in the current database. @@ -79,33 +79,33 @@ The option forces the use of the standard Python interpreter even when IPython is installed. .TP -.BI "sql [" "appname ..." "]" +.BI "sql [" "app_label ..." "]" Prints the CREATE TABLE SQL statements for the given app name(s). .TP -.BI "sqlall [" "appname ..." "]" +.BI "sqlall [" "app_label ..." "]" Prints the CREATE TABLE, initial\-data and CREATE INDEX SQL statements for the given model module name(s). .TP -.BI "sqlclear [" "appname ..." "]" +.BI "sqlclear [" "app_label ..." "]" Prints the DROP TABLE SQL statements for the given app name(s). .TP -.BI "sqlcustom [" "appname ..." "]" +.BI "sqlcustom [" "app_label ..." "]" Prints the custom SQL statements for the given app name(s). .TP -.BI "sqlflush [" "appname ..." "]" +.BI "sqlflush [" "app_label ..." "]" Prints the SQL statements that would be executed for the "flush" command. .TP -.BI "sqlindexes [" "appname ..." "]" +.BI "sqlindexes [" "app_label ..." "]" Prints the CREATE INDEX SQL statements for the given model module name(s). .TP -.BI "sqlinitialdata [" "appname ..." "]" +.BI "sqlinitialdata [" "app_label ..." "]" Prints the initial INSERT SQL statements for the given app name(s). .TP -.BI "sqlsequencereset [" "appname ..." "]" +.BI "sqlsequencereset [" "app_label ..." "]" Prints the SQL statements for resetting PostgreSQL sequences for the given app name(s). .TP -.BI "startapp [" "\-\-template=PATH_OR_URL" "] [" "\-\-extension=EXTENSION" "] [" "\-\-name=FILENAME" "] [" "appname" "] [" "destination" "]" +.BI "startapp [" "\-\-template=PATH_OR_URL" "] [" "\-\-extension=EXTENSION" "] [" "\-\-name=FILENAME" "] [" "app_label" "] [" "destination" "]" Creates a Django app directory structure for the given app name in the current directory or the optional destination. .TP @@ -117,7 +117,7 @@ in the current directory or the optional destination. Runs migrations for apps containing migrations, and just creates missing tables for apps without migrations. .TP -.BI "test [" "\-\-verbosity" "] [" "\-\-failfast" "] [" "appname ..." "]" +.BI "test [" "\-\-verbosity" "] [" "\-\-failfast" "] [" "app_label ..." "]" Runs the test suite for the specified applications, or the entire project if no apps are specified .TP diff --git a/docs/ref/contrib/admin/admindocs.txt b/docs/ref/contrib/admin/admindocs.txt index f903e8efff..c5386c5b2f 100644 --- a/docs/ref/contrib/admin/admindocs.txt +++ b/docs/ref/contrib/admin/admindocs.txt @@ -44,8 +44,8 @@ hyperlinks to other components: ================= ======================= Django Component reStructuredText roles ================= ======================= -Models ``:model:`appname.ModelName``` -Views ``:view:`appname.view_name``` +Models ``:model:`app_label.ModelName``` +Views ``:view:`app_label.view_name``` Template tags ``:tag:`tagname``` Template filters ``:filter:`filtername``` Templates ``:template:`path/to/template.html``` diff --git a/docs/ref/django-admin.txt b/docs/ref/django-admin.txt index 9a458152c9..97923011f0 100644 --- a/docs/ref/django-admin.txt +++ b/docs/ref/django-admin.txt @@ -183,8 +183,8 @@ if they have Django's default value. Such settings are prefixed by ``"###"``. The :djadminopt:`--all` option was added. -dumpdata <appname appname appname.Model ...> --------------------------------------------- +dumpdata <app_label app_label app_label.Model ...> +-------------------------------------------------- .. django-admin:: dumpdata @@ -217,10 +217,10 @@ easy for humans to read, so you can use the ``--indent`` option to pretty-print the output with a number of indentation spaces. The :djadminopt:`--exclude` option may be provided to prevent specific -applications or models (specified as in the form of ``appname.ModelName``) from -being dumped. If you specify a model name to ``dumpdata``, the dumped output -will be restricted to that model, rather than the entire application. You can -also mix application names and model names. +applications or models (specified as in the form of ``app_label.ModelName``) +from being dumped. If you specify a model name to ``dumpdata``, the dumped +output will be restricted to that model, rather than the entire application. +You can also mix application names and model names. The :djadminopt:`--database` option can be used to specify the database from which data will be dumped. @@ -398,7 +398,7 @@ directories will be included in the search path. For example:: django-admin.py loaddata foo/bar/mydata.json -would search ``<appname>/fixtures/foo/bar/mydata.json`` for each installed +would search ``<app_label>/fixtures/foo/bar/mydata.json`` for each installed application, ``<dirname>/foo/bar/mydata.json`` for each directory in :setting:`FIXTURE_DIRS`, and the literal path ``foo/bar/mydata.json``. @@ -587,8 +587,8 @@ Use the ``--keep-pot`` option to prevent Django from deleting the temporary .pot files it generates before creating the .po file. This is useful for debugging errors which may prevent the final language files from being created. -makemigrations [<appname>] --------------------------- +makemigrations [<app_label>] +---------------------------- .. django-admin:: makemigrations @@ -610,8 +610,8 @@ for advanced users and should not be used unless you are familiar with the migration format, migration operations, and the dependencies between your migrations. -migrate [<appname> [<migrationname>]] -------------------------------------- +migrate [<app_label> [<migrationname>]] +--------------------------------------- .. django-admin:: migrate @@ -625,10 +625,10 @@ The behavior of this command changes depending on the arguments provided: * No arguments: All migrated apps have all of their migrations run, and all unmigrated apps are synchronized with the database, -* ``<appname>``: The specified app has its migrations run, up to the most +* ``<app_label>``: The specified app has its migrations run, up to the most recent migration. This may involve running other apps' migrations too, due to dependencies. -* ``<appname> <migrationname>``: Brings the database schema to a state where it +* ``<app_label> <migrationname>``: Brings the database schema to a state where it would have just run the given migration, but no further - this may involve unapplying migrations if you have previously migrated past the named migration. Use the name `zero` to unapply all migrations for an app. @@ -942,8 +942,8 @@ behavior you can use the ``--no-startup`` option. e.g.:: The ``--no-startup`` option was added in Django 1.6. -sql <appname appname ...> -------------------------- +sql <app_label app_label ...> +----------------------------- .. django-admin:: sql @@ -952,8 +952,8 @@ Prints the CREATE TABLE SQL statements for the given app name(s). The :djadminopt:`--database` option can be used to specify the database for which to print the SQL. -sqlall <appname appname ...> ----------------------------- +sqlall <app_label app_label ...> +-------------------------------- .. django-admin:: sqlall @@ -965,8 +965,8 @@ specify initial data. The :djadminopt:`--database` option can be used to specify the database for which to print the SQL. -sqlclear <appname appname ...> ------------------------------- +sqlclear <app_label app_label ...> +---------------------------------- .. django-admin:: sqlclear @@ -975,19 +975,19 @@ Prints the DROP TABLE SQL statements for the given app name(s). The :djadminopt:`--database` option can be used to specify the database for which to print the SQL. -sqlcustom <appname appname ...> -------------------------------- +sqlcustom <app_label app_label ...> +----------------------------------- .. django-admin:: sqlcustom Prints the custom SQL statements for the given app name(s). For each model in each specified app, this command looks for the file -``<appname>/sql/<modelname>.sql``, where ``<appname>`` is the given app name and -``<modelname>`` is the model's name in lowercase. For example, if you have an -app ``news`` that includes a ``Story`` model, ``sqlcustom`` will attempt -to read a file ``news/sql/story.sql`` and append it to the output of this -command. +``<app_label>/sql/<modelname>.sql``, where ``<app_label>`` is the given app +name and ``<modelname>`` is the model's name in lowercase. For example, if you +have an app ``news`` that includes a ``Story`` model, ``sqlcustom`` will +attempt to read a file ``news/sql/story.sql`` and append it to the output of +this command. Each of the SQL files, if given, is expected to contain valid SQL. The SQL files are piped directly into the database after all of the models' @@ -999,8 +999,8 @@ Note that the order in which the SQL files are processed is undefined. The :djadminopt:`--database` option can be used to specify the database for which to print the SQL. -sqldropindexes <appname appname ...> ------------------------------------- +sqldropindexes <app_label app_label ...> +---------------------------------------- .. django-admin:: sqldropindexes @@ -1022,8 +1022,8 @@ command. The :djadminopt:`--database` option can be used to specify the database for which to print the SQL. -sqlindexes <appname appname ...> --------------------------------- +sqlindexes <app_label app_label ...> +------------------------------------ .. django-admin:: sqlindexes @@ -1032,8 +1032,8 @@ Prints the CREATE INDEX SQL statements for the given app name(s). The :djadminopt:`--database` option can be used to specify the database for which to print the SQL. -sqlmigrate <appname> <migrationname> ------------------------------------- +sqlmigrate <app_label> <migrationname> +-------------------------------------- .. django-admin:: sqlmigrate @@ -1050,8 +1050,8 @@ By default, the SQL created is for running the migration in the forwards direction. Pass ``--backwards`` to generate the SQL for un-applying the migration instead. -sqlsequencereset <appname appname ...> --------------------------------------- +sqlsequencereset <app_label app_label ...> +------------------------------------------ .. django-admin:: sqlsequencereset @@ -1066,8 +1066,8 @@ of sync with its automatically incremented field data. The :djadminopt:`--database` option can be used to specify the database for which to print the SQL. -startapp <appname> [destination] --------------------------------- +startapp <app_label> [destination] +---------------------------------- .. django-admin:: startapp diff --git a/docs/topics/migrations.txt b/docs/topics/migrations.txt index ead5ecffdb..6621c4e959 100644 --- a/docs/topics/migrations.txt +++ b/docs/topics/migrations.txt @@ -264,7 +264,7 @@ If your app already has models and database tables, and doesn't have migrations yet (for example, you created it against a previous Django version), you'll need to convert it to use migrations; this is a simple process:: - $ python manage.py makemigrations yourappname + $ python manage.py makemigrations your_app_label This will make a new initial migration for your app. Now, when you run :djadmin:`migrate`, Django will detect that you have an initial migration |