[1.6.x] Fixed #24041 -- Documented effect of changing a model instance's primary key.

Backport of 4ccdf6e57f49d7e981dcd88c1db65229b8b92487 from master

1 files changed, 17 insertions, 0 deletions

diff --git a/docs/topics/db/models.txt b/docs/topics/db/models.txt
index fdfa8b3895..916605f6dc 100644
--- a/docs/topics/db/models.txt
+++ b/docs/topics/db/models.txt
@@ -212,6 +212,23 @@ ones:
     unless you want to override the default primary-key behavior. For more,
     see :ref:`automatic-primary-key-fields`.
 
+    The primary key field is read-only. If you change the value of the primary
+    key on an existing object and then save it, a new object will be created
+    alongside the old one. For example::
+
+        from django.db import models
+
+        class Fruit(models.Model):
+            name = models.CharField(max_length=100, primary_key=True)
+
+    .. code-block:: pycon
+
+        >>> fruit = Fruit.objects.create(name='Apple')
+        >>> fruit.name = 'Pear'
+        >>> fruit.save()
+        >>> Fruit.objects.values_list('name', flat=True)
+        ['Apple', 'Pear']
+
 :attr:`~Field.unique`
     If ``True``, this field must be unique throughout the table.