Updated documentation for blob_writer()
@@ -802,7 +802,17 @@ impl Repository {
}
}
- /// Create stream to write blob
+ /// Create a stream to write blob
+ ///
+ /// This function may need to buffer the data on disk and will in general
+ /// not be the right choice if you know the size of the data to write.
+ ///
+ /// Use `BlobWriter::commit()` to commit the write to the object db
+ /// and get the object id.
+ ///
+ /// If the `hintpath` parameter is filled, it will be used to determine
+ /// what git filters should be applied to the object before it is written
+ /// to the object database.
pub fn blob_writer(&self, hintpath: Option<&Path>) -> Result<BlobWriter, Error> {
let path_str = match hintpath {
Some(path) => Some(try!(path.into_c_string())),
