[tor-commits] [torspec] 03/10: Document the extra NL that sometimes comes with a descriptor

[gitolite role]

This is an automated email from the git hooks/post-receive script.

dgoulet pushed a commit to branch main
in repository torspec.

commit 28d1f6379e99f6e19efb3a7871177ad910094212
Author: Nick Mathewson <nickm at torproject.org>
AuthorDate: Tue Nov 15 17:16:56 2022 -0500

    Document the extra NL that sometimes comes with a descriptor
    
    This NL isn't so easy to remove in Tor, since some older
    control-port code depends on it IIRC.  But not having documented it
    caused arti#637: let's explain that, so that the next unfortunate
    implementor doesn't hit it.
---
 dir-spec.txt | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/dir-spec.txt b/dir-spec.txt
index d2f6c4e..d574e3f 100644
--- a/dir-spec.txt
+++ b/dir-spec.txt
@@ -487,6 +487,12 @@ Table of Contents
    accepted and ignored.  Many of the nonterminals below are defined in
    section 2.1.3.
 
+   Note that many versions of Tor will generate an extra newline at the
+   end of their descriptors.  Implementations MUST tolerate one or
+   more blank lines at the end of a single descriptor or a list of
+   concatenated descriptors.  New implementations SHOULD NOT generate
+   such blank lines.
+
      "router" nickname address ORPort SOCKSPort DirPort NL
 
        [At start, exactly once.]

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.