Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: mirage/mirage
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 99c532295b06
Choose a base ref
...
head repository: mirage/mirage
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 04f3ed8d983f
Choose a head ref
  • 2 commits
  • 1 file changed
  • 2 contributors

Commits on Jun 17, 2015

  1. docs: clarify some expected behaviour for FS module type

    @yomimono
    yomimono committed Jun 17, 2015

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    GPG key ID: B5690EEEBB952194
    Verified
    Learn about vigilant mode
    Copy the full SHA
    aaf3185 View commit details

Commits on Jul 1, 2015

  1. Merge pull request #417 from yomimono/fs_docs 

    docs: clarify some expected behaviour for FS module type
    @samoht
    samoht committed Jul 1, 2015
    Copy the full SHA
    04f3ed8 View commit details
Showing with 11 additions and 3 deletions.
  1. +11 −3 types/V1.mli
14 changes: 11 additions & 3 deletions types/V1.mli
View file
Original file line number Diff line number Diff line change
@@ -823,10 +823,14 @@ module type FS = sig
filesystem of size [size] bytes. *)

val create: t -> string -> [ `Ok of unit | `Error of error ] io
(** [create t path] creates an empty file at [path]. *)
(** [create t path] creates an empty file at [path]. If [path] contains
directories that do not yet exist, [create] will attempt to create them. *)

val mkdir: t -> string -> [ `Ok of unit | `Error of error ] io
(** [mkdir t path] creates an empty directory at [path]. *)
(** [mkdir t path] creates an empty directory at [path]. If [path] contains
intermediate directories that do not yet exist, [mkdir] will create them.
If a directory already exists at [path], [mkdir] returns [`Ok ()] and
takes no action. *)

val destroy: t -> string -> [ `Ok of unit | `Error of error ] io
(** [destroy t path] removes a [path] (which may be a file or an
@@ -842,7 +846,11 @@ module type FS = sig

val write: t -> string -> int -> page_aligned_buffer -> [ `Ok of unit | `Error of error ] io
(** [write t path offset data] writes [data] at [offset] in file
[path] on filesystem [t]. *)
[path] on filesystem [t].
If [path] contains directories that do not exist, [write] will attempt to
create them. If [path] already exists, [write] will overwrite existing
information starting at [off].*)

end