Andrew Godwin avatar Andrew Godwin committed aa34963

Docs fixes.

Comments (0)

Files changed (2)

docs/commands.rst

  - ``--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.
+ 
+
+convert_to_south
+----------------
+
+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`
+section.

docs/tutorial/part1.rst

 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
 :ref:`tutorial-part-2`.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.