Skip to content

Commit d870edc

Browse files
committed
pathrs-lite: update README to mention libpathrs build-tag
Signed-off-by: Aleksa Sarai <[email protected]>
1 parent 5109cf6 commit d870edc

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

pathrs-lite/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@ Go** implementation of the core bits of [libpathrs][]. This is not intended to
55
be a complete replacement for libpathrs, instead it is mainly intended to be
66
useful as a transition tool for existing Go projects.
77

8-
The long-term plan for `pathrs-lite` is to provide a build tag that will cause
9-
all `pathrs-lite` operations to call into libpathrs directly, thus removing
10-
code duplication for projects that wish to make use of libpathrs (and providing
11-
the ability for software packagers to opt-in to libpathrs support without
12-
needing to patch upstream).
8+
`pathrs-lite` also provides a very easy way to switch to `libpathrs` (even for
9+
downstreams where `pathrs-lite` is being used in a third-party package and is
10+
not interested in using CGo). At build time, if you use the `libpathrs` build
11+
tag then `pathrs-lite` will use `libpathrs` directly instead of the pure Go
12+
implementation. The two backends are functionally equivalent (and we have
13+
integration tests to verify this), so this migration should be very easy with
14+
no user-visible impact.
1315

1416
[libpathrs]: https://github.com/cyphar/libpathrs
1517

0 commit comments

Comments
 (0)