Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

lib: sync README.md with reality #101

Merged
merged 1 commit into from
Aug 31, 2023
Merged

lib: sync README.md with reality #101

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions lib/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,6 @@
This directory contains the general sqsh archive handling. It contains
functionality to open/instantiate and close squashfs images.

### [easy](./easy)

This directory contains code that eases the usage of this library. It wraps
complex functionality into easy to use functions.

### [data](./data)

This directory contains on-disk structures for squashfs. It does not contain
Expand All @@ -19,6 +14,11 @@ any logic except for byte order conversion.

This directory contains code that does directory handling.

### [easy](./easy)

This directory contains code that eases the usage of this library. It wraps
complex functionality into easy to use functions.

### [extract](./extract)

This directory contains the glue code to the different compression algorithms
Expand All @@ -43,16 +43,25 @@ the [`curl_mapper`](./mapper/curl_mapper.c)
This directory contains code that takes care of handling
[metadata blocks](https://dr-emann.github.io/squashfs/squashfs.html#_packing_metadata)

### [primitive](./primitive)
### [reader](./reader)

This directory contains low level data structures such as dynamic buffers,
hash maps, and lru handling.
This directory contains the generic reader code. It is responsible to abstract
random forward reads on top of memory block iterators like the file iterator,
the map iterator, or the metablock iterator.

### [table](./table)

This directory contains code handling to access generic directly addressable
[lookup tables](https://dr-emann.github.io/squashfs/squashfs.html#_storing_lookup_tables).

### [tree](./table)

This directory contains code abstracting the directory tree and path handling.

### [utils](./utils)

Utility functions that are used throughout the library.

### [xattr](./xattr)

This directory contains code for handling and iterating fields in the
Expand Down