From 679f4898226e9f2366f5230ae627672521d5468b Mon Sep 17 00:00:00 2001
From: Marc-Antoine Ruel <maruel@gmail.com>
Date: Sat, 29 May 2021 13:26:07 -0400
Subject: [PATCH] Add note that this repository is obsolete

---
 README.md                            | 28 ++------------------------
 doc.go                               |  4 ++--
 experimental/hostextra/usbbus/doc.go | 30 +---------------------------
 hostextra/d2xx/doc.go                | 16 ++-------------
 hostextra/doc.go                     |  8 ++------
 5 files changed, 9 insertions(+), 77 deletions(-)

diff --git a/README.md b/README.md
index 1638e76..f96a9be 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,7 @@
 # periph extra!
 
-[![mascot](https://raw.githubusercontent.com/periph/website/master/site/static/img/periph-mascot-280.png)](https://periph.io/)
-
-Supplemental tools for [periph.io/x/periph](https://periph.io/x/periph) that
-cannot live there. It may be because the tool/library:
-
-- depends on external packages
-- uses cgo
-
-[![Go Report Card](https://goreportcard.com/badge/periph.io/x/extra)](https://goreportcard.com/report/periph.io/x/extra)
-[![Coverage Status](https://codecov.io/gh/periph/extra/graph/badge.svg)](https://codecov.io/gh/periph/extra)
-[![Build Status](https://travis-ci.org/periph/extra.svg)](https://travis-ci.org/periph/extra)
-[![Gitter chat](https://badges.gitter.im/google/periph.png)](https://gitter.im/periph-io/Lobby)
-
-
-## Install
-
-Install the whole suite with `periphextra` enabled to have access to the full
-functionality:
-
-```
-go get -u periph.io/x/extra/cmd/...
-go install -tags periphextra periph.io/x/periph/cmd/...
-```
-
-See https://periph.io for more details.
-
+This repository is obsolete.
+Please use https://periph.io/x/host/v3 (or later) directly.
 
 ## Authors
 
diff --git a/doc.go b/doc.go
index 4db826f..35ec494 100644
--- a/doc.go
+++ b/doc.go
@@ -2,7 +2,7 @@
 // Use of this source code is governed under the Apache License, Version 2.0
 // that can be found in the LICENSE file.
 
-// Package extra is for documentation only.
+// Package extra is obsolete.
 //
-// For for help, see https://github.com/periph/extra/tree/master/README.md
+// Please use https://periph.io/x/host/v3 (or later) directly.
 package extra
diff --git a/experimental/hostextra/usbbus/doc.go b/experimental/hostextra/usbbus/doc.go
index df17d9b..4a5a83e 100644
--- a/experimental/hostextra/usbbus/doc.go
+++ b/experimental/hostextra/usbbus/doc.go
@@ -2,33 +2,5 @@
 // Use of this source code is governed under the Apache License, Version 2.0
 // that can be found in the LICENSE file.
 
-// Package usbbus implements OS specific functions for conn/usb.
-//
-// This includes handling the connected devices on process startup and handling
-// of the connection events.
-//
-// This package is only built with the build tag 'usb' because it causes a
-// dependency on https://github.com/kylelemons/gousb. This package uses cgo that
-// depends on libusb being installed. This is generally not the case by
-// default, so it causes a go get failure which is really obnoxious to users.
-//
-// Debian
-//
-// This includes Raspbian and Ubuntu.
-//
-// First configure cgo as explained at https://periph.io/x/extra#hdr-Debian.
-//
-// You need to install libusb-1.0:
-//
-//  sudo apt install libusb-1.0-0-dev
-//
-// MacOS
-//
-// First configure cgo as explained at https://periph.io/x/extra#hdr-MacOS.
-//
-//  brew install libusb
-//
-// Windows
-//
-// The package is currently disabled on Windows.
+// Package usbbus never worked and is obsolete.
 package usbbus
diff --git a/hostextra/d2xx/doc.go b/hostextra/d2xx/doc.go
index 0f9e996..30540b2 100644
--- a/hostextra/d2xx/doc.go
+++ b/hostextra/d2xx/doc.go
@@ -2,19 +2,7 @@
 // Use of this source code is governed under the Apache License, Version 2.0
 // that can be found in the LICENSE file.
 
-// Package d2xx is a cgo wrapper for the FTDI d2xx drive.
+// Package d2xx is obsolete.
 //
-// The supported devices (ft232h/ft232r) implement support for various
-// protocols like the GPIO, I²C, SPI, UART, JTAG.
-//
-// More details
-//
-// See https://periph.io/device/ftdi/ for more details, and how to configure
-// the host to be able to use this driver.
-//
-// Datasheets
-//
-// http://www.ftdichip.com/Support/Documents/DataSheets/ICs/DS_FT232R.pdf
-//
-// http://www.ftdichip.com/Support/Documents/DataSheets/ICs/DS_FT232H.pdf
+// Please use https://periph.io/x/host/v3 (or later) directly.
 package d2xx
diff --git a/hostextra/doc.go b/hostextra/doc.go
index 1512290..b22e0fd 100644
--- a/hostextra/doc.go
+++ b/hostextra/doc.go
@@ -2,11 +2,7 @@
 // Use of this source code is governed under the Apache License, Version 2.0
 // that can be found in the LICENSE file.
 
-// Package hostextra defines the extra drivers for the host itself.
+// Package hostextra is obsolete.
 //
-// The host is the machine where this code is running.
-//
-// Subpackages contain the drivers that are loaded automatically. Contrary to
-// periph.io/x/periph/host, hostextra loads drivers that depends on either third
-// party Go packages and/or on cgo.
+// Please use https://periph.io/x/host/v3 (or later) directly.
 package hostextra