Added informative comment

2023-08-09 18:29:02 +02:00
parent bafe313749
commit cce21700eb
1 changed files with 3 additions and 0 deletions
--- a/serial_linux.go
+++ b/serial_linux.go
@@ -87,5 +87,8 @@ func setTermSettingsBaudrate(speed int, settings *unix.Termios) (error, bool) {
 }

 func (port *unixPort) Drain() error {
+	// It's not super well documented, but this is the same as calling tcdrain:
+	// - https://git.musl-libc.org/cgit/musl/tree/src/termios/tcdrain.c
+	// - https://elixir.bootlin.com/linux/v6.2.8/source/drivers/tty/tty_io.c#L2673
 	return unix.IoctlSetInt(port.handle, unix.TCSBRK, 1)
 }