aboutsummaryrefslogtreecommitdiffstats
path: root/pktline/doc.go
diff options
context:
space:
mode:
authorMáximo Cuadros <mcuadros@gmail.com>2015-10-23 12:05:02 +0200
committerMáximo Cuadros <mcuadros@gmail.com>2015-10-23 12:05:02 +0200
commit214e1dca024fb6da5ed65564d2de734df5dc2127 (patch)
tree0c2805a0676006690a8053ae8ccee388ccfc83fe /pktline/doc.go
parent70923099e61fa33f0bc5256d2f938fa44c4df10e (diff)
downloadgo-git-214e1dca024fb6da5ed65564d2de734df5dc2127.tar.gz
format/pktline: review and improving coverage
Diffstat (limited to 'pktline/doc.go')
-rw-r--r--pktline/doc.go56
1 files changed, 0 insertions, 56 deletions
diff --git a/pktline/doc.go b/pktline/doc.go
deleted file mode 100644
index a976b54..0000000
--- a/pktline/doc.go
+++ /dev/null
@@ -1,56 +0,0 @@
-package pktline
-
-// pkt-line Format
-// ---------------
-//
-// Much (but not all) of the payload is described around pkt-lines.
-//
-// A pkt-line is a variable length binary string. The first four bytes
-// of the line, the pkt-len, indicates the total length of the line,
-// in hexadecimal. The pkt-len includes the 4 bytes used to contain
-// the length's hexadecimal representation.
-//
-// A pkt-line MAY contain binary data, so implementors MUST ensure
-// pkt-line parsing/formatting routines are 8-bit clean.
-//
-// A non-binary line SHOULD BE terminated by an LF, which if present
-// MUST be included in the total length.
-//
-// The maximum length of a pkt-line's data component is 65520 bytes.
-// Implementations MUST NOT send pkt-line whose length exceeds 65524
-// (65520 bytes of payload + 4 bytes of length data).
-//
-// Implementations SHOULD NOT send an empty pkt-line ("0004").
-//
-// A pkt-line with a length field of 0 ("0000"), called a flush-pkt,
-// is a special case and MUST be handled differently than an empty
-// pkt-line ("0004").
-//
-// ----
-// pkt-line = data-pkt / flush-pkt
-//
-// data-pkt = pkt-len pkt-payload
-// pkt-len = 4*(HEXDIG)
-// pkt-payload = (pkt-len - 4)*(OCTET)
-//
-// flush-pkt = "0000"
-// ----
-//
-// Examples (as C-style strings):
-//
-// ----
-// pkt-line actual value
-// ---------------------------------
-// "0006a\n" "a\n"
-// "0005a" "a"
-// "000bfoobar\n" "foobar\n"
-// "0004" ""
-// ----
-//
-// Extracted from:
-// https://github.com/git/git/blob/master/Documentation/technical/protocol-common.txt
-
-const (
- HEADER_LENGTH = 4
- MAX_LENGTH = 65524
-)