From 2a74ac31d24be52a096746315eda046392b81023 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dariusz=20G=C3=B3recki?= <darek.krk@gmail.com>
Date: Thu, 12 Jan 2012 19:15:35 +0100
Subject: [PATCH] Add info about BC Break to CHANGELOG-2.1 and UPGRADE-2.1

---
 UPGRADE-2.1.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/UPGRADE-2.1.md b/UPGRADE-2.1.md
index a1560677f9..1e502083a7 100644
--- a/UPGRADE-2.1.md
+++ b/UPGRADE-2.1.md
@@ -40,3 +40,31 @@ UPGRADE FROM 2.0 to 2.1
 
   Before: $session->getLocale()
   After: $request->getLocale()
+
+* Method `equals` of `Symfony\Component\Security\Core\User\UserInterface` has
+  moved to `Symfony\Component\Security\Core\User\EquatableInterface`.
+
+  You have to change the name of the `equals` function in your implementation
+  of the `User` class to `isEqualTo` and implement `EquatableInterface`.
+  Apart from that, no other changes are required to make it behave as before.
+  Alternatively, you can use the default implementation provided
+  by `AbstractToken:hasUserChanged` if you do not need any custom comparison logic.
+  In this case do not implement the interface and remove your comparison function.
+
+  Before:
+
+      class User implements UserInterface
+      {
+          // ...
+          public function equals(UserInterface $user) { /* ... */ }
+          // ...
+      }
+
+  After:
+
+      class User implements UserInterface, EquatableInterface
+      {
+          // ...
+          public function isEqualTo(UserInterface $user) { /* ... */ }
+          // ...
+      }