[tor-commits] [tor/master] Improve the documentation of AccountingStart parameter.

[nickm at torproject.org]

commit eb089ecaa023eaacd06f042e67bf4b4adda1c8ee
Author: Fernando Fernandez Mancera <ffmancera at riseup.net>
Date:   Mon Feb 12 17:10:04 2018 +0100

    Improve the documentation of AccountingStart parameter.
    
    Fixes #23635.
    
    Signed-off-by: Fernando Fernandez Mancera <ffmancera at riseup.net>
---
 changes/ticket23635 |  3 +++
 doc/tor.1.txt       | 19 ++++++++++---------
 2 files changed, 13 insertions(+), 9 deletions(-)

diff --git a/changes/ticket23635 b/changes/ticket23635
new file mode 100644
index 000000000..54d303e4b
--- /dev/null
+++ b/changes/ticket23635
@@ -0,0 +1,3 @@
+  o Documentation:
+    - Improved the documentation of AccountingStart paremeter.
+      Closes ticket 23635.
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 5ad818365..54375300a 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -2170,15 +2170,16 @@ is non-zero):
     (Default: max)
 
 [[AccountingStart]] **AccountingStart** **day**|**week**|**month** [__day__] __HH:MM__::
-    Specify how long accounting periods last. If **month** is given, each
-    accounting period runs from the time __HH:MM__ on the __dayth__ day of one
-    month to the same day and time of the next. (The day must be between 1 and
-    28.) If **week** is given, each accounting period runs from the time __HH:MM__
-    of the __dayth__ day of one week to the same day and time of the next week,
-    with Monday as day 1 and Sunday as day 7. If **day** is given, each
-    accounting period runs from the time __HH:MM__ each day to the same time on
-    the next day. All times are local, and given in 24-hour time. (Default:
-    "month 1 0:00")
+    Specify how long accounting periods last. If **month** is given,
+    each accounting period runs from the time __HH:MM__ on the __dayth__ day of one
+    month to the same day and time of the next. The relay will go at full speed,
+    use all the quota you specify, then hibernate for the rest of the month.(The
+    day must be between 1 and 28.) If **week** is given, each accounting period
+    runs from the time __HH:MM__ of the __dayth__ day of one week to the same day
+    and time of the next week, with Monday as day 1 and Sunday as day 7. If **day**
+    is given, each accounting period runs from the time __HH:MM__ each day to the
+    same time on the next day. All times are local, and given in 24-hour time.
+    (Default: "month 1 0:00")
 
 [[RefuseUnknownExits]] **RefuseUnknownExits** **0**|**1**|**auto**::
     Prevent nodes that don't appear in the consensus from exiting using this