Browse Source

Fixed #22932: Documented circular dependency issues with swappable user

Andrew Godwin 10 years ago
parent
commit
e9249bc20b
1 changed files with 8 additions and 0 deletions
  1. 8 0
      docs/topics/auth/customizing.txt

+ 8 - 0
docs/topics/auth/customizing.txt

@@ -399,6 +399,14 @@ use as your User model.
    is created in the first migration of its app (usually called ``0001_initial``);
    otherwise, you will have dependency issues.
 
+   In addition, you may run into a CircularDependencyError when running your
+   migrations as Django won't be able to automatically break the dependency
+   loop due to the dynamic dependency. If you see this error, you should
+   break the loop by moving the models depended on by your User model
+   into a second migration (you can try making two normal models that
+   have a ForeignKey to each other and seeing how ``makemigrations`` resolves that
+   circular dependency if you want to see how it's usually done)
+
 
 Referencing the User model
 --------------------------