1. Jannis Leidel
  2. south


Andrew Godwin  committed aa34963

Docs fixes.

  • Participants
  • Parent commits f1e11f8
  • Branches default

Comments (0)

Files changed (2)

File docs/commands.rst

View file
  • Ignore whitespace
  - ``--no-initial-data``: Doesn't load in any initial data fixtures after a
    full upwards migration, if there are any.
  - ``--fake``: Records the migration sequence as having been applied, but
-   doesn't actually run it. Useful for ConvertingAnApp.
+   doesn't actually run it. Useful for :ref:`converting-an-app`.
  - ``--db-dry-run``: Loads and runs the migration, but doesn't actually
    access the database (the SQL generated is thrown away at the last minute).
    The migration is also not recorded as being run; this is useful for
  - ``--all``: Makes syncdb operate on all apps, not just unmigrated ones.
+An alias command that both creates an initial migration for an app and then
+fake-applies it. Takes one argument, the app label of the app to convert::
+ ./manage.py convert_to_south myapp
+There's more documentation on how to use this in the :ref:`converting-an-app`

File docs/tutorial/part1.rst

View file
  • Ignore whitespace
 With that, our new column is created; again, go and check, you'll be able to
 add Knights who can dance whenever they're able.
+Converting existing apps
+Sometimes, especially when introducting South into a project, you will want
+to use it for existing apps - ones for which the tables have already been created.
+This is different from adding migrations to an all-new app, and you should
+see the :ref:`converting-an-app` page for more information on how to do it.
 Once you're happy with this basic usage of South, move on to