SquashFS compressed filesystem reader in pure OCaml
fix(E410): add periods and fix [name] format in doc comments
- squashfs_writer.mli: add periods to @param/@raise/@item tags
- streaming_aead.mli: add periods to @return tags
- tar_eio.mli: fix value/append_file/header_of_file doc style
- tar.mli: fix fold [name args] format
- tc.mli: add periods, fix make_header [name args] format
+16
-16
+16
-16
lib/squashfs_writer.mli
+16
-16
lib/squashfs_writer.mli
···
70
70
(** [create ?compression ?block_size ?mtime ()] creates a new squashfs
71
71
filesystem builder.
72
72
73
-
@param compression Compression algorithm (default: Gzip)
73
+
@param compression Compression algorithm (default: Gzip).
74
74
@param block_size
75
75
Data block size, must be power of 2 between 4096 and 1048576 (default:
76
-
131072 = 128KB)
77
-
@param mtime Modification time for all entries (default: current time) *)
76
+
131072 = 128KB).
77
+
@param mtime Modification time for all entries (default: current time). *)
78
78
79
79
(** {1 Adding Entries} *)
80
80
···
84
84
Parent directories are created automatically with mode 0o755 if they don't
85
85
exist.
86
86
87
-
@raise Invalid_argument if [path] is invalid (absolute, contains "..") *)
87
+
@raise Invalid_argument if [path] is invalid (absolute, contains ".."). *)
88
88
89
89
val add_file : t -> string -> mode:int -> string -> unit
90
90
(** [add_file fs path ~mode content] adds a regular file at [path] with the
···
92
92
93
93
Parent directories are created automatically.
94
94
95
-
@raise Invalid_argument if [path] is invalid or [content] exceeds size limit
96
-
*)
95
+
@raise Invalid_argument
96
+
if [path] is invalid or [content] exceeds size limit. *)
97
97
98
98
val add_symlink : t -> string -> string -> unit
99
99
(** [add_symlink fs path target] adds a symbolic link at [path] pointing to
100
100
[target].
101
101
102
-
@raise Invalid_argument if [path] is invalid or [target] is empty *)
102
+
@raise Invalid_argument if [path] is invalid or [target] is empty. *)
103
103
104
104
val add_device :
105
105
t -> string -> mode:int -> char:bool -> major:int -> minor:int -> unit
106
106
(** [add_device fs path ~mode ~char ~major ~minor] adds a device node.
107
107
108
-
@param char [true] for character device, [false] for block device
109
-
@raise Invalid_argument if [path] is invalid *)
108
+
@param char [true] for character device, [false] for block device.
109
+
@raise Invalid_argument if [path] is invalid. *)
110
110
111
111
val add_fifo : t -> string -> mode:int -> unit
112
112
(** [add_fifo fs path ~mode] adds a named pipe (FIFO) at [path].
113
113
114
-
@raise Invalid_argument if [path] is invalid *)
114
+
@raise Invalid_argument if [path] is invalid. *)
115
115
116
116
val add_socket : t -> string -> mode:int -> unit
117
117
(** [add_socket fs path ~mode] adds a Unix domain socket at [path].
118
118
119
-
@raise Invalid_argument if [path] is invalid *)
119
+
@raise Invalid_argument if [path] is invalid. *)
120
120
121
121
val add_tree : t -> _ Eio.Path.t -> string -> unit
122
122
(** [add_tree fs source_dir archive_prefix] recursively adds all files and
···
124
124
125
125
Preserves file types, permissions, and symlink targets.
126
126
127
-
@raise Invalid_argument if paths are invalid
128
-
@raise Eio.Io if [source_dir] cannot be read *)
127
+
@raise Invalid_argument if paths are invalid.
128
+
@raise Eio.Io if [source_dir] cannot be read. *)
129
129
130
130
(** {1 Finalization} *)
131
131
···
135
135
After calling [finalize], the filesystem builder should not be used again.
136
136
137
137
The returned string contains a valid squashfs image that can be:
138
-
- Written to a file and mounted with [mount -t squashfs]
139
-
- Read back with {!Squashfs.of_string}
140
-
- Used directly as a partition in a disk image *)
138
+
- Written to a file and mounted with [mount -t squashfs].
139
+
- Read back with {!Squashfs.of_string}.
140
+
- Used directly as a partition in a disk image. *)
141
141
142
142
val write : t -> Bytesrw.Bytes.Writer.t -> unit
143
143
(** [write fs writer] writes the squashfs image to a byte writer.