Skip to content

Commit c0deb4c

Browse files
committed
Update README
1 parent cc944b7 commit c0deb4c

File tree

1 file changed

+24
-23
lines changed

1 file changed

+24
-23
lines changed

README.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,40 @@ ocamlfuse
22
=========
33

44
This repository is cloned from the last CVS snapshot of
5-
[OCamlFuse](http://sourceforge.net/projects/ocamlfuse/), with:
5+
[OCamlFuse](https://sourceforge.net/projects/ocamlfuse/), with:
66
* Patches (see [#1](https://github.com/astrada/ocamlfuse/pull/1) and [#3](https://github.com/astrada/ocamlfuse/pull/3)) to make it compile on Mac OS X.
77
* Fix for a race condition in multi-threaded mode (see [#4](https://github.com/astrada/ocamlfuse/issue/4)).
88
* [dune](https://github.com/ocaml/dune) support (see [#12](https://github.com/astrada/ocamlfuse/pull/12)).
9+
* See all the merged [PR](https://github.com/astrada/ocamlfuse/pulls?q=is%3Apr+is%3Aclosed)
910

1011
INTRODUCTION
1112

12-
This is a binding to fuse for the ocaml programming language, enabling
13-
you to write multithreaded filesystems in the ocaml language. It has
13+
This is a binding to `fuse` for the OCaml programming language, enabling
14+
you to write multithreaded filesystems with the OCaml language. It has
1415
been designed with simplicity as a goal, as you can see by looking at
15-
example/fusexmp.ml. Efficiency has also been a separate goal. The
16-
Bigarray library is used for read and writes, allowing the library to
17-
do zero-copy in ocaml land.
16+
`example/fusexmp.ml`. Efficiency has also been a separate goal. The
17+
`Bigarray` library is used for read and writes, allowing the library to
18+
do zero-copy in OCaml land.
1819

1920
REQUIREMENTS
2021

21-
You need fuse (version 2.7 or greater)
22+
You need `fuse` (version 2.7 or greater)
2223

23-
http://www.sourceforge.net/projects/fuse
24+
https://www.sourceforge.net/projects/fuse
2425

25-
You also need ocaml >= 4.02.3 and camlidl >= 1.05.
26+
You also need `OCaml >= 4.02.3` and `camlidl >= 1.05`.
2627

2728
GETTING STARTED
2829

29-
The reccomended way to install this library is using
30-
[OPAM](http://opam.ocaml.org/).
30+
The recommended way to install this library is with
31+
[opam](https://opam.ocaml.org/).
3132

3233
opam install ocamlfuse
3334

3435

3536
INSTALLATION
3637

37-
If you don't want to install OPAM, you need to manually install this
38+
If you don't want to install `opam`, you need to manually install this
3839
prerequisites:
3940

4041
1) Prerequisites
@@ -49,17 +50,17 @@ prerequisites:
4950

5051
- OCaml >= 4.02.3
5152

52-
Should be there in the major linux distributions, but is also available at
53+
Should be in the major linux distributions, but is also available at
5354

54-
https://www.ocaml.org
55+
https://ocaml.org
5556

5657
- CamlIDL >= 1.05
5758

5859
present at least in ubuntu, also available at
5960

6061
https://github.com/xavierleroy/camlidl
6162

62-
- dune >= 1.6
63+
- dune >= 3.7
6364

6465
available at
6566

@@ -73,7 +74,7 @@ prerequisites:
7374
make install
7475

7576
This will install ocamlfuse in your ocaml library directory. To uninstall
76-
it you can use "make uninstall"
77+
it you can run `make uninstall`.
7778

7879
TESTING
7980

@@ -91,24 +92,24 @@ KNOWN PROBLEMS (if you can help, please do)
9192

9293
- The stateful interface for readdir is not implemented
9394

94-
- There is a stub in Fuse_util.c regarding st_blocks - if one
95+
- There is a stub in `Fuse_util.c` regarding `st_blocks` - if one
9596
implements statfs with a block size different
9697
than 512 "du" will not work on the filesystem.
9798

9899
- many ocaml exceptions are reported as 127
99100

100-
- we should add non-blocking lstat64 and statfs,*xattr implementations for
101-
ocaml in Unix_util
101+
- we should add non-blocking `lstat64` and `statfs`, `*xattr` implementations
102+
for ocaml in `Unix_util`
102103

103104
- translation between ocaml unix errors and C unix error is dependent
104105
on the order of constructor names in ocaml. There should be a way to
105106
get error names from caml and create a translation table.
106107

107-
- the Unix_util library uses unsafe coercions between unix file
108+
- the `Unix_util` library uses unsafe coercions between unix file
108109
handles (which are defined as ints) and ints. Even if this works, in
109110
the future it might stop working.
110111

111-
- IMPORTANT: Unix_util.read and write operations have not been tested
112+
- IMPORTANT: `Unix_util.read` and `write` operations have not been tested
112113
in case of errors. Error code conversion might be incorrect but I
113114
don't have test cases (maybe the easy way is to modify fusexmp to
114115
return various errors).
@@ -119,7 +120,7 @@ KNOWN PROBLEMS (if you can help, please do)
119120

120121
- Some errors are missing in the unix module (e.g. ENOTSUP,ENOATTR,
121122
see man lsxattr). We could solve all these problems with errors using
122-
a custom error type instead of unix_error but this would create
123+
a custom error type instead of `unix_error` but this would create
123124
troubles.
124125

125126
- deadlock (and consequent necessity to kill -KILL the program) if
@@ -153,7 +154,7 @@ encouraged to post feedback there and in general to subscribe if you use ocamlfu
153154

154155
The sourceforge page for ocamlfuse is
155156

156-
http://sourceforge.net/projects/ocamlfuse
157+
https://sourceforge.net/projects/ocamlfuse
157158

158159
Bye and have fun
159160

0 commit comments

Comments
 (0)