Deprecate repo.Refs.Move() in favor of repo.Refs.Rename() #752

Author: JPaulDuncan

LibGit2Sharp/Core/HistoryRewriter.cs

@@ -181,8 +181,8 @@ private Reference RewriteReference<TRef, TTarget>(
                 return refMap[oldRef] = newRef;
             }
 
-            var movedRef = repo.Refs.Move(newRef, newRefName);
-            rollbackActions.Enqueue(() => repo.Refs.Move(newRef, oldRef.CanonicalName));
+            var movedRef = repo.Refs.Rename(newRef, newRefName);
+            rollbackActions.Enqueue(() => repo.Refs.Rename(newRef, oldRef.CanonicalName));
             return refMap[oldRef] = movedRef;
         }
 

LibGit2Sharp/ReferenceCollection.cs

@@ -151,7 +151,35 @@ public virtual void Remove(Reference reference)
         /// <param name="logMessage">Message added to the reflog.</param>
         /// <param name="allowOverwrite">True to allow silent overwriting a potentially existing reference, false otherwise.</param>
         /// <returns>A new <see cref="Reference"/>.</returns>
+        [Obsolete("Use Rename instead.")]
         public virtual Reference Move(Reference reference, string newName, Signature signature, string logMessage = null, bool allowOverwrite = false)
+        {
+            return Rename(reference, newName, signature, logMessage, allowOverwrite);
+        }
+
+        /// <summary>
+        /// Rename an existing reference with a new name
+        /// </summary>
+        /// <param name="reference">The reference to rename.</param>
+        /// <param name="newName">The new canonical name.</param>
+        /// <param name="allowOverwrite">True to allow silent overwriting a potentially existing reference, false otherwise.</param>
+        /// <returns>A new <see cref="Reference"/>.</returns>
+        [Obsolete("Use Rename instead.")]
+        public virtual Reference Move(Reference reference, string newName, bool allowOverwrite = false)
+        {
+            return Rename(reference, newName, null, null, allowOverwrite);
+        }
+
+        /// <summary>
+        /// Rename an existing reference with a new name, and update the reflog
+        /// </summary>
+        /// <param name="reference">The reference to rename.</param>
+        /// <param name="newName">The new canonical name.</param>
+        /// <param name="signature">Identity used for updating the reflog.</param>
+        /// <param name="logMessage">Message added to the reflog.</param>
+        /// <param name="allowOverwrite">True to allow silent overwriting a potentially existing reference, false otherwise.</param>
+        /// <returns>A new <see cref="Reference"/>.</returns>
+        public virtual Reference Rename(Reference reference, string newName, Signature signature, string logMessage = null, bool allowOverwrite = false)
         {
             Ensure.ArgumentNotNull(reference, "reference");
             Ensure.ArgumentNotNullOrEmptyString(newName, "newName");
@@ -176,9 +204,9 @@ public virtual Reference Move(Reference reference, string newName, Signature sig
         /// <param name="newName">The new canonical name.</param>
         /// <param name="allowOverwrite">True to allow silent overwriting a potentially existing reference, false otherwise.</param>
         /// <returns>A new <see cref="Reference"/>.</returns>
-        public virtual Reference Move(Reference reference, string newName, bool allowOverwrite = false)
+        public virtual Reference Rename(Reference reference, string newName, bool allowOverwrite = false)
         {
-            return Move(reference, newName, null, null, allowOverwrite);
+            return Rename(reference, newName, null, null, allowOverwrite);
         }
 
         internal T Resolve<T>(string name) where T : Reference

LibGit2Sharp/ReferenceCollectionExtensions.cs

@@ -148,7 +148,7 @@ public static Reference Move(this ReferenceCollection refsColl, string currentNa
                         "Reference '{0}' doesn't exist. One cannot move a non existing reference.", currentName));
             }
 
-            return refsColl.Move(reference, newName, signature, logMessage, allowOverwrite);
+            return refsColl.Rename(reference, newName, signature, logMessage, allowOverwrite);
         }
 
         /// <summary>