Browse Source

doc: Explain how to avoid inconsistent reads on V3BandwidthsFile

Closes 26702.
teor 5 years ago
parent
commit
08b82409d4
1 changed files with 3 additions and 1 deletions
  1. 3 1
      doc/tor.1.txt

+ 3 - 1
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