From: teor <teor2345@gmail.com>
Date: Wed, 18 Jul 2018 01:14:18 +0000 (+1000)
Subject: doc: Explain how to avoid inconsistent reads on V3BandwidthsFile
X-Git-Tag: tor-0.3.5.1-alpha~198^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=08b82409d462bae454b073a9913f199b4c75ed3b;p=thirdparty%2Ftor.git

doc: Explain how to avoid inconsistent reads on V3BandwidthsFile

Closes 26702.
---

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index f42ad0dd3c..1db8cabf86 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