From b78e887ba097decb2fc774ab70f2bd8a671f9928 Mon Sep 17 00:00:00 2001
From: Vincent Sanders <vince@kyllikki.org>
Date: Tue, 13 Sep 2016 23:38:22 +0100
Subject: Add documentation on the cookie version field

---
 include/netsurf/cookie_db.h | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'include/netsurf')

diff --git a/include/netsurf/cookie_db.h b/include/netsurf/cookie_db.h
index 54d014508..a5cd48991 100644
--- a/include/netsurf/cookie_db.h
+++ b/include/netsurf/cookie_db.h
@@ -27,6 +27,14 @@
 #include <stdbool.h>
 #include <time.h>
 
+/**
+ * Version of cookie
+ *
+ * RFC2109 and RFC2965 "HTTP State Management Mechanism" defined
+ * alternative versions of cookies. Nothing used them and these RFC
+ * are now obsoleted by RFC6265 which completely removes the
+ * alternative versions.
+ */
 enum cookie_version {
 	COOKIE_NETSCAPE = 0,
 	COOKIE_RFC2109 = 1,
-- 
cgit v1.2.3