seek_hole: update documentation

rust-vmm / vmm-sys-util

Helpers and utilities used by multiple rust-vmm components and VMMs

BSD 3-Clause "New" or "Revised" License

79 stars 64 forks source link

seek_hole: update documentation #36

Closed andreeaflorescu closed 5 years ago

andreeaflorescu commented 5 years ago

Added high level documentation. Separated existing documentation into summary and details.

This commit does not include examples for SeekHole trait because we need a lot of boiler plate code to do that (we need to create a temporary directory, create a file, write something to the file and only then we are able to call into seek_data or seek_hole).

liujing2 commented 5 years ago

Need a refactor before merging. Thanks!

andreeaflorescu commented 5 years ago

@liujing2 what refactor is needed?

liujing2 commented 5 years ago

@liujing2 what refactor is needed?

Typo. Just rebase. Codes are fine to me. :)