Andrew Godwin avatar Andrew Godwin committed 11f3034

Fix #482: Docs on meta freezing

Comments (0)

Files changed (1)

docs/ormfreezing.rst

 Note that you can only access models that have been frozen; South automatically
 includes anything that could be reaches via foreign keys or many-to-many
 relationships, but if you want to add other models in, simply pass ``--freeze appname``
-to the ``./manage.py datamigration`` command.
+to the ``./manage.py datamigration`` command.
+
+Frozen Meta Attributes
+----------------------
+
+As well as freezing fields (for which South has a whole slew of rules on
+what to freeze - see :ref:`extending-introspection`), it also freezes certain
+meta attributes of a model (the ones which we think will have an impact on the
+table schema or your frozen ORM use).
+
+Currently, South freezes::
+
+ db_table
+ db_tablespace
+ unique_together
+ ordering
+
+If there's something else you think should be frozen in the Meta, but which
+isn't, file a bug and we'll look into it.
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.