Merge pull request #9753 from stgraber/master

shared/usbid: Document reasons to fork
lxc · Jan 4, 2022 · 63791e2 · 63791e2
2 parents 4e46ec8 + 090675c
commit 63791e2
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/shared/usbid/README.md b/shared/usbid/README.md
@@ -0,0 +1,11 @@
+This Go package is a variant of `usbid` from https://github.com/google/gousb.
+It was written by the gousb maintainers and contributors and then adapted for use by LXD.
+
+Main changes:
+ - Doesn't load on import (reduced memory footprint).
+ - Uses system-local USB database (to always match `lsusb`).
+ - Doesn't import anything outside of built-in Go packages.
+ - Doesn't use or indirectly rely on CGO as this code is often used in cross-built static binaries.
+
+Most users will want to stick to the upstream google/gousb version instead.
+This fork is really meant for LXD's special use case and may be further trimmed down in the future.