[tor-commits] [tor/master] Document the output of --version

[nickm at torproject.org]

commit 508837b62bcb31afbba711ec3dd7b7c18630d604
Author: Nick Mathewson <nickm at torproject.org>
Date:   Mon Dec 17 17:54:01 2018 -0500

    Document the output of --version
    
    Closes 28889
---
 changes/document_version | 2 ++
 doc/tor.1.txt            | 3 ++-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/changes/document_version b/changes/document_version
new file mode 100644
index 000000000..a45992b6b
--- /dev/null
+++ b/changes/document_version
@@ -0,0 +1,2 @@
+  o Documentation:
+    - Document the exact output of "tor --version". Closes ticket 28889.
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 8c419b1a6..4ecc4ee38 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -89,7 +89,8 @@ COMMAND-LINE OPTIONS
     future version. (This is a warning, not a promise.)
 
 [[opt-version]] **--version**::
-    Display Tor version and exit.
+    Display Tor version and exit. The output is a line of the format,
+    "Tor version [version number]."
 
 [[opt-quiet]] **--quiet**|**--hush**::
     Override the default console log.  By default, Tor starts out logging