Skip to content

Commit 0e54ba5

Browse files
committedMar 10, 2025·
README, TODO: add dircache notes.
1 parent 5a7678e commit 0e54ba5

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed
 

‎README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ is a new and potentially harmul feature so do not experiment on a unique
171171
copy of an ADF image with your precious data. Do it on a copy (and report
172172
if any issues are encountered).
173173

174-
Update: The notice above is especially actual that it was discovered that
174+
Update: The notice above is especially actual as it was discovered that
175175
the version `0.8.0` and earlier **do not rebuild the block allocation bitmap
176176
for volumes where it is marked invalid**. In short, this means that if the bitmap
177177
is really incorrect, writing to such volume may lead to data loss/corruption
@@ -180,6 +180,18 @@ Because of this, it is strongly advised to **UPDATE TO THE LATEST VERSION**.
180180

181181
(See also TODO and BUGS).
182182

183+
### DirCache
184+
Dircache is an existing but somewhat exotic feature of the FFS.
185+
Until now, I haven't encountered any disk image with this enabled. The only
186+
one with dircache set on the volume is one of the test floppies for the ADFlib
187+
(testffs.adf)...
188+
189+
While dircache support is implemented in ADFlib (at least, to certain extent),
190+
so far, there are no tests of dircache. As such, assume that this feature is
191+
practically **not tested**.
192+
While it can be used rather safely in read-only mode, be very careful with
193+
write mode using a volume with dircache enabled.
194+
183195

184196
## The API documentation in doc/
185197
... in major part is outdated. The lib underwent many changes and, possibly,

‎TODO

+4
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@ To do and/or consider (no particular order):
5151
automatically in CI, it rather should be done on a VM or some special box
5252
dedicated for such purpose.
5353

54+
* Test dircache
55+
56+
So far, there are no "real" images available (only testffs.adf in ADFlib...)
57+
and, hence, no real need for testing this. But should be done at some point.
5458

5559
* Review and update the API
5660

0 commit comments

Comments
 (0)
Please sign in to comment.