Skip to content

Commit

Permalink
Remove warning about using unxip in your program
Browse files Browse the repository at this point in the history
This is obviously at odds to vending libunxip. More specifically,
though, while unxip schedules all over the cooperative thread pool, most
clients seem to not really expect to use it heavily anyways (since they
are small wrappers around the API, perhaps with some UI). For those that
actually do plan to do work there, Swift Concurrency does an OK job of
having the work share available resources. I don't expect this to be a
major problem and those that it is one for can probably figure out how
to work around it themselves, or reach out and ask in the worst case.
  • Loading branch information
saagarjha committed Jan 31, 2024
1 parent 3169e60 commit 42a01b0
Showing 1 changed file with 0 additions and 2 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,6 @@ $ make install

The installation prefix is configurable via the `PREFIX` variable.

unxip is not currently designed to be embedded directly into the address space of another application. While it would "work" (with minor modifications to allow linking) its implementation expects to be the only user of the cooperative thread pool and effectively takes it over, which may adversely affect other code that wishes to run on it. The recommended way to use unxip is spawning it as a subtask.

## Usage

The intended usage of unxip is with a single command line parameter that represents the path to an XIP from Apple that contains Xcode. For example:
Expand Down

0 comments on commit 42a01b0

Please sign in to comment.