Merge pull request #1185 from Vogel612/HistoryRewriting_and_Documentaton

nulltoken · nulltoken · commit e6f9e9764cb6 · 2015-10-26T17:53:10.000+01:00
History rewriting and documentaton
diff --git a/LibGit2Sharp.Tests/FilterBranchFixture.cs b/LibGit2Sharp.Tests/FilterBranchFixture.cs
@@ -191,10 +191,10 @@ public void CanRewriteAuthorOfCommitsOnlyBeingPointedAtByTags()
             AssertSucceedingButNotError();
 
             var lightweightTag = repo.Tags["so-lonely"];
-            Assert.Equal("Bam!\n", ((Commit)lightweightTag.Target).Message);
+            Assert.Equal("Bam!", ((Commit)lightweightTag.Target).Message);
 
             var annotatedTag = repo.Tags["so-lonely-but-annotated"];
-            Assert.Equal("Bam!\n", ((Commit)annotatedTag.Target).Message);
+            Assert.Equal("Bam!", ((Commit)annotatedTag.Target).Message);
         }
 
         [Fact]
@@ -495,7 +495,7 @@ public void DoesNotRewriteRefsThatDontChange()
             var parents = repo.Branches["br2"].Tip.Parents.ToList();
             Assert.Equal(2, parents.Count());
             Assert.NotEmpty(parents.Where(c => c.Sha.StartsWith("9fd738e")));
-            Assert.Equal("abc\n", parents.Single(c => !c.Sha.StartsWith("9fd738e")).Message);
+            Assert.Equal("abc", parents.Single(c => !c.Sha.StartsWith("9fd738e")).Message);
         }
 
         [Fact]
@@ -530,7 +530,7 @@ public void CanNotOverWriteBackedUpReferences()
             AssertErrorFired(ex);
             AssertSucceedingNotFired();
 
-            Assert.Equal("abc\n", repo.Head.Tip.Message);
+            Assert.Equal("abc", repo.Head.Tip.Message);
 
             var newOriginalRefs = repo.Refs.FromGlob("refs/original/*").OrderBy(r => r.CanonicalName).ToArray();
             Assert.Equal(originalRefs, newOriginalRefs);
@@ -791,7 +791,7 @@ public void HandlesNameRewritingOfChainedTags()
             var newCommit = newAnnotationC.Target as Commit;
             Assert.NotNull(newCommit);
             Assert.NotEqual(newCommit, theCommit);
-            Assert.Equal("Rewrote\n", newCommit.Message);
+            Assert.Equal("Rewrote", newCommit.Message);
 
             // Ensure the original tag doesn't exist anymore
             Assert.Null(repo.Tags["lightweightA"]);
diff --git a/LibGit2Sharp/Commit.cs b/LibGit2Sharp/Commit.cs
@@ -54,7 +54,7 @@ internal Commit(Repository repo, ObjectId id)
         /// <summary>
         /// Gets the <see cref="TreeEntry"/> pointed at by the <paramref name="relativePath"/> in the <see cref="Tree"/>.
         /// </summary>
-        /// <param name="relativePath">The relative path to the <see cref="TreeEntry"/> from the <see cref="Commit"/> working directory.</param>
+        /// <param name="relativePath">Path to the <see cref="TreeEntry"/> from the tree in this <see cref="Commit"/></param>
         /// <returns><c>null</c> if nothing has been found, the <see cref="TreeEntry"/> otherwise.</returns>
         public virtual TreeEntry this[string relativePath]
         {
diff --git a/LibGit2Sharp/Core/HistoryRewriter.cs b/LibGit2Sharp/Core/HistoryRewriter.cs
@@ -52,7 +52,7 @@ public void Execute()
                 var commits = repo.Commits.QueryBy(filter);
                 foreach (var commit in commits)
                 {
-                    RewriteCommit(commit);
+                    RewriteCommit(commit, options);
                 }
 
                 // Ordering matters. In the case of `A -> B -> commit`, we need to make sure B is rewritten
@@ -199,7 +199,7 @@ private Reference RewriteReference<TRef, TTarget>(
             return refMap[oldRef] = movedRef;
         }
 
-        private void RewriteCommit(Commit commit)
+        private void RewriteCommit(Commit commit, RewriteHistoryOptions options)
         {
             var newHeader = CommitRewriteInfo.From(commit);
             var newTree = commit.Tree;
@@ -248,7 +248,7 @@ private void RewriteCommit(Commit commit)
                                                              newHeader.Message,
                                                              newTree,
                                                              mappedNewParents,
-                                                             true);
+                                                             options.PrettifyMessages);
 
             // Record the rewrite
             objectMap[commit] = newCommit;
diff --git a/LibGit2Sharp/RewriteHistoryOptions.cs b/LibGit2Sharp/RewriteHistoryOptions.cs
@@ -77,5 +77,13 @@ public RewriteHistoryOptions()
         /// </para>
         /// </summary>
         public Action<Exception> OnError { get; set; }
+
+        /// <summary>
+        /// Specifies Commit message prettifying behavior during rewrite.
+        /// NOTE: Prettifying may result in losing one or multiple lines in the commit message.
+        /// As such it is recommended to leave this set to false.
+        /// </summary>
+        /// <value><c>true</c> if Commit messages are prettified; otherwise, <c>false</c>.</value>
+        public bool PrettifyMessages { get; set; }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ internal Commit(Repository repo, ObjectId id)`
`54`	`54`	`/// <summary>`
`55`	`55`	`/// Gets the <see cref="TreeEntry"/> pointed at by the <paramref name="relativePath"/> in the <see cref="Tree"/>.`
`56`	`56`	`/// </summary>`
`57`		`- /// <param name="relativePath">The relative path to the <see cref="TreeEntry"/> from the <see cref="Commit"/> working directory.</param>`
	`57`	`+ /// <param name="relativePath">Path to the <see cref="TreeEntry"/> from the tree in this <see cref="Commit"/></param>`
`58`	`58`	`/// <returns><c>null</c> if nothing has been found, the <see cref="TreeEntry"/> otherwise.</returns>`
`59`	`59`	`public virtual TreeEntry this[string relativePath]`
`60`	`60`	`{`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public void Execute()`
`52`	`52`	`var commits = repo.Commits.QueryBy(filter);`
`53`	`53`	`foreach (var commit in commits)`
`54`	`54`	`{`
`55`		`- RewriteCommit(commit);`
	`55`	`+ RewriteCommit(commit, options);`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	// Ordering matters. In the case of `A -> B -> commit`, we need to make sure B is rewritten
`@@ -199,7 +199,7 @@ private Reference RewriteReference<TRef, TTarget>(`
`199`	`199`	`return refMap[oldRef] = movedRef;`
`200`	`200`	`}`
`201`	`201`
`202`		`- private void RewriteCommit(Commit commit)`
	`202`	`+ private void RewriteCommit(Commit commit, RewriteHistoryOptions options)`
`203`	`203`	`{`
`204`	`204`	`var newHeader = CommitRewriteInfo.From(commit);`
`205`	`205`	`var newTree = commit.Tree;`
`@@ -248,7 +248,7 @@ private void RewriteCommit(Commit commit)`
`248`	`248`	`newHeader.Message,`
`249`	`249`	`newTree,`
`250`	`250`	`mappedNewParents,`
`251`		`- true);`
	`251`	`+ options.PrettifyMessages);`
`252`	`252`
`253`	`253`	`// Record the rewrite`
`254`	`254`	`objectMap[commit] = newCommit;`
Original file line number	Diff line number	Diff line change
`@@ -77,5 +77,13 @@ public RewriteHistoryOptions()`
`77`	`77`	`/// </para>`
`78`	`78`	`/// </summary>`
`79`	`79`	`public Action<Exception> OnError { get; set; }`
	`80`	`+`
	`81`	`+ /// <summary>`
	`82`	`+ /// Specifies Commit message prettifying behavior during rewrite.`
	`83`	`+ /// NOTE: Prettifying may result in losing one or multiple lines in the commit message.`
	`84`	`+ /// As such it is recommended to leave this set to false.`
	`85`	`+ /// </summary>`
	`86`	`+ /// <value><c>true</c> if Commit messages are prettified; otherwise, <c>false</c>.</value>`
	`87`	`+ public bool PrettifyMessages { get; set; }`
`80`	`88`	`}`
`81`	`89`	`}`