Andrew Godwin avatar Andrew Godwin committed bc928f8

Add documentation on graphmigrations.

Comments (0)

Files changed (1)

docs/commands.rst

 ^^^^^^^
 
  - ``--freeze``: Use appname or appname.modelname to freeze additional models into the app.
- - ``--stdout``: Writes the migration to stdout instead of a file.
+ - ``--stdout``: Writes the migration to stdout instead of a file.
+ 
+ 
+graphmigrations
+---------------
+
+*(New in South 0.7)*
+
+Run this command to generate a graphviz .dot file for your migrations; you
+can then use this to generate a graph of your migrations' dependencies.
+
+Typical usage::
+
+ ./manage.py graphmigrations | dot -omigrations.png
+ 
+This command can be particularly helpful to examine complex dependency sets
+between lots of different apps [#]_.
+
+ .. [#] This command was written and used for the first time while helping the
+        debug the rather complex set of dependencies in django-cms; it's quite
+        a sight to behold.
+
+Options
+^^^^^^^
+
+This command has no options.
+
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.