Merge TCP aborted(), timedout() and closed() methods into a single

[people/xl0/gpxe.git] / src / include / gpxe / ftp.h

diff --git a/src/include/gpxe/ftp.h b/src/include/gpxe/ftp.h
index f2db5a1..6063abe 100644 (file)
--- a/src/include/gpxe/ftp.h
+++ b/src/include/gpxe/ftp.h
@@ -10,6 +10,12 @@
 #include <stdint.h>
 #include <gpxe/tcp.h>
 
+/**
+ * FTP states
+ *
+ * These @b must be sequential, i.e. a successful FTP session must
+ * pass through each of these states in order.
+ */
 enum ftp_state {
        FTP_CONNECT = 0,
        FTP_USER,