]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
HTTP-COOKIES: mention that a trailing newline is required
authorDaniel Stenberg <daniel@haxx.se>
Tue, 18 Feb 2020 13:23:04 +0000 (14:23 +0100)
committerDaniel Stenberg <daniel@haxx.se>
Wed, 19 Feb 2020 07:04:35 +0000 (08:04 +0100)
... so that we know we got the whole and not a partial line.

Also, changed the formatting of the fields away from a table again since
the table format requires a github-markdown tool version that we don't
run on the web server atm.

Reported-by: Sunny Bean
Fixes #4946
Closes #4947

docs/HTTP-COOKIES.md

index 62367c2a9abfaec7cc67769b8f2e5ae9a89d0630..31af9f6d9b9e5f6fd411191e9a5a856b9c1ba3c2 100644 (file)
   that start with `#` are treated as comments.
 
   Each line that each specifies a single cookie consists of seven text fields
-  separated with TAB characters.
-
-  |Field| Type  | Example     | Meaning                                       |
-  |---|---------|-------------|-----------------------------------------------|
-  | 0 | string  | example.com | Domain name                                   |
-  | 1 | boolean | FALSE       | Include subdomains                            |
-  | 2 | string  | /foobar/    | Path                                          |
-  | 3 | boolean | TRUE        | Send/receive over HTTPS only                  |
-  | 4 | number  | 1462299217  | Expires at – seconds since Jan 1st 1970, or 0 |
-  | 5 | string  | person      | Name of the cookie                            |
-  | 6 | string  | daniel      | Value of the cookie                           |
+  separated with TAB characters. A valid line must end with a newline
+  character.
+
+### Fields in the file
+
+  Field number, what type and example data and the meaning of it:
+
+  0. string `example.com` - the domain name
+  1. boolean `FALSE` - include subdomains
+  2. string `/foobar/` - path
+  3. boolean `TRUE` - send/receive over HTTPS only
+  4. number `1462299217` - expires at - seconds since Jan 1st 1970, or 0
+  5. string `person` - name of the cookie
+  6. string `daniel` - value of the cookie
 
 ## Cookies with curl the command line tool