Inform about resource usage in the docs

Related to #10

Author: Byron

Cargo.toml

@@ -6,7 +6,7 @@ keywords = ["crates", "index", "diff"]
 license = "MIT"
 name = "crates-index-diff"
 repository = "https://github.com/Byron/crates-index-diff-rs"
-version = "7.1.1"
+version = "7.1.2"
 edition = "2018"
 readme = "changelog.md"
 include = ["src/**/*", "LICENSE.md", "README.md", "changelog.md"]

changelog.md

@@ -1,3 +1,7 @@
+## v7.1.2 (2020-05-28)
+
+* Documentation update
+
 ## v7.1.1 (2020-05-23)
 
 * Make new feature from v7.1.0 actually usable

src/index.rs

@@ -123,6 +123,14 @@ impl Index {
     /// The second field in the returned tuple is the commit object to which the changes were provided.
     /// If one would set the `last_seen_reference()` to that object, the effect is exactly the same
     /// as if `fetch_changes(…)` had been called.
+    ///
+    /// # Resource Usage
+    ///
+    /// As this method fetches the git repository, loose objects or small packs may be created. Over time,
+    /// these will accumulate and either slow down subsequent operations, or cause them to fail due to exhaustion
+    /// of the maximum number of open file handles as configured with `ulimit`.
+    ///
+    /// Thus it is advised for the caller to run `git gc` occasionally based on their own requirements and usage patterns.
     pub fn peek_changes_with_options(
         &self,
         options: Option<&mut git2::FetchOptions<'_>>,
@@ -163,6 +171,14 @@ impl Index {
     /// the remote called `origin`.
     /// The `last_seen_reference()` will be created or adjusted to point to the latest fetched
     /// state, which causes this method to have a different result each time it is called.
+    ///
+    /// # Resource Usage
+    ///
+    /// As this method fetches the git repository, loose objects or small packs may be created. Over time,
+    /// these will accumulate and either slow down subsequent operations, or cause them to fail due to exhaustion
+    /// of the maximum number of open file handles as configured with `ulimit`.
+    ///
+    /// Thus it is advised for the caller to run `git gc` occasionally based on their own requirements and usage patterns.
     pub fn fetch_changes_with_options(
         &self,
         options: Option<&mut git2::FetchOptions<'_>>,