summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrew Godwin <andrew@aeracode.org>2014-07-29 10:10:31 -0700
committerAndrew Godwin <andrew@aeracode.org>2014-07-29 10:10:31 -0700
commitb9a9b052e8b4a47504abc0f14be3087aaa700e47 (patch)
tree9a590253d12af020a53dc1ca8f4ef536f0a1c7f7
parent8ebd6d35d77c1c535a9ffe8151445ad853845b61 (diff)
Fixed #23127: south_migrations note in docs
-rw-r--r--docs/topics/migrations.txt18
1 files changed, 17 insertions, 1 deletions
diff --git a/docs/topics/migrations.txt b/docs/topics/migrations.txt
index c9d6ee0e5d..893a46bd2a 100644
--- a/docs/topics/migrations.txt
+++ b/docs/topics/migrations.txt
@@ -599,7 +599,7 @@ Upgrading from South
--------------------
If you already have pre-existing migrations created with
-`South 0.x <http://south.aeracode.org>`_, then the upgrade process to use
+`South <http://south.aeracode.org>`_, then the upgrade process to use
``django.db.migrations`` is quite simple:
* Ensure all installs are fully up-to-date with their migrations
@@ -616,3 +616,19 @@ of foreign keys; in this case, ``makemigrations`` might make more than one
initial migration, and you'll need to mark them all as applied using::
python manage.py migrate --fake yourappnamehere
+
+Libraries/Third-party Apps
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you are a library or app maintainer, and wish to support both South migrations
+(for Django 1.6 and below) and Django migrations (for 1.7 and above) you should
+keep two parallel migration sets in your app, one in each format.
+
+To aid in this, South 1.0 will automatically look for South-format migrations
+in a ``south_migrations`` directory first, before looking in ``migrations``,
+meaning that users' projects will transparently use the correct set as long
+as you put your South migrations in the ``south_migrations`` directory and
+your Django migrations in the ``migrations`` directory.
+
+More information is available in the
+`South 1.0 release notes <http://south.readthedocs.org/en/latest/releasenotes/1.0.html#library-migration-path>`_.