[tor-commits] [tor/master] doc: Explain how to avoid inconsistent reads on V3BandwidthsFile

[nickm at torproject.org]

commit 08b82409d462bae454b073a9913f199b4c75ed3b
Author: teor <teor2345 at gmail.com>
Date:   Wed Jul 18 11:14:18 2018 +1000

    doc: Explain how to avoid inconsistent reads on V3BandwidthsFile
    
    Closes 26702.
---
 doc/tor.1.txt | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index f42ad0dd3..1db8cabf8 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -2747,7 +2747,9 @@ on the public Tor network.
 [[V3BandwidthsFile]] **V3BandwidthsFile** __FILENAME__::
     V3 authoritative directories only. Configures the location of the
     bandwidth-authority generated file storing information on relays' measured
-    bandwidth capacities. (Default: unset)
+    bandwidth capacities. To avoid inconsistent reads, bandwidth data should
+    be written to temporary file, then renamed to the configured filename.
+    (Default: unset)
 
 [[V3AuthUseLegacyKey]] **V3AuthUseLegacyKey** **0**|**1**::
     If set, the directory authority will sign consensuses not only with its