Prepare 2.0-beta-2 release

square · Aug 2, 2019 · 24673a4 · 24673a4
1 parent 414b969
commit 24673a4
Show file tree

Hide file tree

Showing 13 changed files with 36 additions and 13 deletions.
diff --git a/docs/api/shark-graph/shark/-heap-graph/gc-roots.md b/docs/api/shark-graph/shark/-heap-graph/gc-roots.md
@@ -5,5 +5,7 @@
 `abstract val gcRoots: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<GcRoot>`
 
 All GC roots which type matches types known to this heap graph and which point to non null
-references.
+references. You can retrieve the object that a GC Root points to by calling [findObjectById](find-object-by-id.md)
+with [GcRoot.id](#), however you need to first check that [objectExists](object-exists.md) returns true because
+GC roots can point to objects that don't exist in the heap dump.
 
diff --git a/docs/api/shark-graph/shark/-heap-graph/index.md b/docs/api/shark-graph/shark/-heap-graph/index.md
@@ -12,7 +12,7 @@ Enables navigation through the heap graph of objects.
 |---|---|
 | [classes](classes.md) | `abstract val classes: `[`Sequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)`<`[`HeapObject.HeapClass`](../-heap-object/-heap-class/index.md)`>`<br>Sequence of all classes in the heap dump. |
 | [context](context.md) | `abstract val context: `[`GraphContext`](../-graph-context/index.md)<br>In memory store that can be used to store objects this [HeapGraph](./index.md) instance. |
-| [gcRoots](gc-roots.md) | `abstract val gcRoots: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<GcRoot>`<br>All GC roots which type matches types known to this heap graph and which point to non null references. |
+| [gcRoots](gc-roots.md) | `abstract val gcRoots: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<GcRoot>`<br>All GC roots which type matches types known to this heap graph and which point to non null references. You can retrieve the object that a GC Root points to by calling [findObjectById](find-object-by-id.md) with [GcRoot.id](#), however you need to first check that [objectExists](object-exists.md) returns true because GC roots can point to objects that don't exist in the heap dump. |
 | [identifierByteSize](identifier-byte-size.md) | `abstract val identifierByteSize: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) |
 | [instances](instances.md) | `abstract val instances: `[`Sequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)`<`[`HeapObject.HeapInstance`](../-heap-object/-heap-instance/index.md)`>`<br>Sequence of all instances in the heap dump. |
 | [objects](objects.md) | `abstract val objects: `[`Sequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)`<`[`HeapObject`](../-heap-object/index.md)`>`<br>Sequence of all objects in the heap dump. |

diff --git a/docs/api/shark-graph/shark/-hprof-heap-graph/gc-roots.md b/docs/api/shark-graph/shark/-hprof-heap-graph/gc-roots.md
@@ -7,5 +7,7 @@
 Overrides [HeapGraph.gcRoots](../-heap-graph/gc-roots.md)
 
 All GC roots which type matches types known to this heap graph and which point to non null
-references.
+references. You can retrieve the object that a GC Root points to by calling [findObjectById](../-heap-graph/find-object-by-id.md)
+with [GcRoot.id](#), however you need to first check that [objectExists](../-heap-graph/object-exists.md) returns true because
+GC roots can point to objects that don't exist in the heap dump.
 
diff --git a/docs/api/shark-graph/shark/-hprof-heap-graph/index.md b/docs/api/shark-graph/shark/-hprof-heap-graph/index.md
@@ -12,7 +12,7 @@ A [HeapGraph](../-heap-graph/index.md) that reads from an indexed [Hprof](#). Cr
 |---|---|
 | [classes](classes.md) | `val classes: `[`Sequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)`<`[`HeapObject.HeapClass`](../-heap-object/-heap-class/index.md)`>`<br>Sequence of all classes in the heap dump. |
 | [context](context.md) | `val context: `[`GraphContext`](../-graph-context/index.md)<br>In memory store that can be used to store objects this [HeapGraph](../-heap-graph/index.md) instance. |
-| [gcRoots](gc-roots.md) | `val gcRoots: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<GcRoot>`<br>All GC roots which type matches types known to this heap graph and which point to non null references. |
+| [gcRoots](gc-roots.md) | `val gcRoots: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<GcRoot>`<br>All GC roots which type matches types known to this heap graph and which point to non null references. You can retrieve the object that a GC Root points to by calling [findObjectById](../-heap-graph/find-object-by-id.md) with [GcRoot.id](#), however you need to first check that [objectExists](../-heap-graph/object-exists.md) returns true because GC roots can point to objects that don't exist in the heap dump. |
 | [identifierByteSize](identifier-byte-size.md) | `val identifierByteSize: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) |
 | [instances](instances.md) | `val instances: `[`Sequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)`<`[`HeapObject.HeapInstance`](../-heap-object/-heap-instance/index.md)`>`<br>Sequence of all instances in the heap dump. |
 | [objects](objects.md) | `val objects: `[`Sequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)`<`[`HeapObject`](../-heap-object/index.md)`>`<br>Sequence of all objects in the heap dump. |

diff --git a/...nalysis-progress-listener/-step/-r-e-p-o-r-t-i-n-g_-h-e-a-p_-a-n-a-l-y-s-i-s.md b/...nalysis-progress-listener/-step/-r-e-p-o-r-t-i-n-g_-h-e-a-p_-a-n-a-l-y-s-i-s.md
@@ -0,0 +1,5 @@
+[shark](../../../index.md) / [shark](../../index.md) / [OnAnalysisProgressListener](../index.md) / [Step](index.md) / [REPORTING_HEAP_ANALYSIS](./-r-e-p-o-r-t-i-n-g_-h-e-a-p_-a-n-a-l-y-s-i-s.md)
+
+# REPORTING_HEAP_ANALYSIS
+
+`REPORTING_HEAP_ANALYSIS`
diff --git a/docs/api/shark/shark/-on-analysis-progress-listener/-step/index.md b/docs/api/shark/shark/-on-analysis-progress-listener/-step/index.md
@@ -15,3 +15,4 @@
 | [COMPUTING_NATIVE_RETAINED_SIZE](-c-o-m-p-u-t-i-n-g_-n-a-t-i-v-e_-r-e-t-a-i-n-e-d_-s-i-z-e.md) |  |
 | [COMPUTING_RETAINED_SIZE](-c-o-m-p-u-t-i-n-g_-r-e-t-a-i-n-e-d_-s-i-z-e.md) |  |
 | [BUILDING_LEAK_TRACES](-b-u-i-l-d-i-n-g_-l-e-a-k_-t-r-a-c-e-s.md) |  |
+| [REPORTING_HEAP_ANALYSIS](-r-e-p-o-r-t-i-n-g_-h-e-a-p_-a-n-a-l-y-s-i-s.md) |  |
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,11 +1,24 @@
 # Change Log
 
-## Version 2.0 Beta 1 (2019-07-30)
+## Version 2.0 Beta 2 (2019-08-02)
 
 LeakCanary 2 reached **beta status**: the internals and APIs are mostly stable.
 
 Now is a great time to adopt it and provide feedback before the stable release. We're counting on you to find bugs and suggest improvements! Check out the new [Getting Started](https://square.github.io/leakcanary/getting_started) instructions and the [migration guide](https://square.github.io/leakcanary/upgrading-to-leakcanary-2.0/). 
 
+* Fixed *Leak analysis failed: Object id not found in heap dump.* [#1516](https://github.com/square/leakcanary/issues/1516)
+* 10x speed increase of hprof indexing on large heap dumps [#1520](https://github.com/square/leakcanary/pull/1520)
+
+Many thanks to
+[@kolphi](https://github.com/kolphi),
+[@pyricau](https://github.com/pyricau),
+[@ZacSweers](https://github.com/ZacSweers)
+for the contributions, bug reports and feature requests.
+
+For more details, see the [2.0-beta-2 Milestone](https://github.com/square/leakcanary/milestone/10) and the [full diff](https://github.com/square/leakcanary/compare/v2.0-beta-1...v2.0-beta-2).
+
+## Version 2.0 Beta 1 (2019-07-30)
+
 * New standalone library! [Shark](shark.md) is the heap analyzer that powers LeakCanary 2, and it can run in any Java VM. It comes with a [CLI](shark.md#shark-cli): you can now run `shark-cli analyze-process com.example.myapp` from your computer.
 * New Heap Explorer directly on device! Open a Heap Analysis in LeakCanary, tap the options menu and select "Heap Explorer". This is still experimental and not very user friendly, contributions welcome!
 * **Large API rewrite** to improve usability. If you used the alpha with a customized configuration, there are breaking changes. Of note: LeakSentry became [AppWatcher](/leakcanary/api/leakcanary-object-watcher-android/leakcanary/-app-watcher/), RefWatcher became [ObjectWatcher](/leakcanary/api/leakcanary-object-watcher/leakcanary/-object-watcher/), AndroidExcludedRefs became [AndroidReferenceMatchers](/leakcanary/api/shark-android/shark/-android-reference-matchers/), AnalysisResultListener became [OnHeapAnalyzedListener](/leakcanary/api/leakcanary-android-core/leakcanary/-on-heap-analyzed-listener/), AndroidLeakTraceInspectors became [AndroidObjectInspectors](/leakcanary/api/shark-android/shark/-android-object-inspectors/).
@@ -23,7 +36,7 @@ Many thanks to
 [@snkashis](https://github.com/snkashis)
 for the contributions, bug reports and feature requests.
 
-For more details, see the [2.0-beta-1 Milestone](https://github.com/square/leakcanary/milestone/1) and the [full diff](https://github.com/square/leakcanary/compare/v2.0-alpha-3...v2.0-beta-1).
+For more details, see the [2.0-beta-1 Milestone](https://github.com/square/leakcanary/milestone/9) and the [full diff](https://github.com/square/leakcanary/compare/v2.0-alpha-3...v2.0-beta-1).
 
 ## Version 2.0 Alpha 3 (2019-07-04)
 

diff --git a/docs/faq.md b/docs/faq.md
@@ -46,7 +46,7 @@ Update your dependencies to the latest SNAPSHOT (see [build.gradle](https://gith
 
 ```gradle
  dependencies {
-   debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.0-beta-2-SNAPSHOT'
+   debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.0-beta-3-SNAPSHOT'
  }
 ```
 

diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -5,7 +5,7 @@ Add LeakCanary to `build.gradle`:
 ```groovy
 dependencies {
   // debugImplementation because LeakCanary should only run in debug builds.
-  debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.0-beta-1'
+  debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.0-beta-2'
 }
 ```
 

diff --git a/docs/recipes.md b/docs/recipes.md
@@ -67,7 +67,7 @@ In your `build.gradle`:
 
 ```gradle
 dependencies {
-  implementation 'com.squareup.leakcanary:object-watcher-android:2.0-beta-1'
+  implementation 'com.squareup.leakcanary:object-watcher-android:2.0-beta-2'
 }
 ```
 

diff --git a/docs/shark.md b/docs/shark.md
@@ -31,7 +31,7 @@ A few more things:
 
 The Shark Command Line Interface (CLI) enables you to analyze heaps directly from your computer. It can dump the heap of an app installed on a connected Android device, analyze it, and even strip a heap dump of any sensitive data (e.g. PII, passwords or encryption keys) which is useful when sharing a heap dump.
 
-Download it [here](https://github.com/square/leakcanary/releases/download/v2.0-beta-1/shark-cli-2.0-beta-1.zip)!
+Download it [here](https://github.com/square/leakcanary/releases/download/v2.0-beta-2/shark-cli-2.0-beta-2.zip)!
 
 Usage instructions:
 

diff --git a/docs/upgrading-to-leakcanary-2.0.md b/docs/upgrading-to-leakcanary-2.0.md
@@ -22,7 +22,7 @@ dependencies {
 
 ```groovy
 dependencies {
-  debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.0-beta-1'
+  debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.0-beta-2'
 }
 ```
 
@@ -85,7 +85,7 @@ If you were using `RefWatcher` in non debug code, you now get a compile error be
 
 ```groovy
 dependencies {
-  implementation 'com.squareup.leakcanary:object-watcher-android:2.0-beta-1'
+  implementation 'com.squareup.leakcanary:object-watcher-android:2.0-beta-2'
 }
 ```
 

diff --git a/gradle.properties b/gradle.properties
@@ -1,5 +1,5 @@
 GROUP=com.squareup.leakcanary
-VERSION_NAME=2.0-beta-2-SNAPSHOT
+VERSION_NAME=2.0-beta-2
 
 POM_DESCRIPTION=Leak Canary