[tor-commits] [sbws/master] docs: add comments to the example config file

[juga at torproject.org]

commit 4e606a3e4e44d47a14bd0db5404c5c225895bf6a
Author: juga0 <juga at riseup.net>
Date:   Fri Nov 30 15:59:19 2018 +0000

    docs: add comments to the example config file
    
    And rename it to sbws.
---
 docs/source/config.rst                                        | 4 ++--
 docs/source/examples/{config.example.ini => sbws.example.ini} | 4 +++-
 2 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/docs/source/config.rst b/docs/source/config.rst
index 5e7f14f..5aabc29 100644
--- a/docs/source/config.rst
+++ b/docs/source/config.rst
@@ -27,8 +27,8 @@ The user example config file provided by ``sbws`` might look like this.
 
 .. _init-config:
 
-.. literalinclude:: /examples/config.example.ini
-    :caption: Example config.example.ini
+.. literalinclude:: /examples/sbws.example.ini
+    :caption: Example sbws.example.ini
 
 **No other configuration files are read.**
 
diff --git a/docs/source/examples/config.example.ini b/docs/source/examples/sbws.example.ini
similarity index 70%
rename from docs/source/examples/config.example.ini
rename to docs/source/examples/sbws.example.ini
index f3ca1da..0130bdb 100644
--- a/docs/source/examples/config.example.ini
+++ b/docs/source/examples/sbws.example.ini
@@ -4,7 +4,9 @@
 nickname = sbws_default
 
 [destinations]
-foo = off
+# a destination can be disabled changing `on` by `off`
+foo = on
 
 [destinations.foo]
+# the domain and path to the 1GB file.
 url = https://example.com/does/not/exist.bin