[tor-commits] [sbws/master] Add the .sbws layout in man, removed from INSTALL

[juga at torproject.org]

commit b26a71bfb6dbb0f3cff4d76396ca68eab23ceab3
Author: juga0 <juga at riseup.net>
Date:   Fri Sep 14 17:53:28 2018 +0000

    Add the .sbws layout in man, removed from INSTALL
---
 README.md                | 16 ----------------
 docs/source/man_sbws.rst | 17 +++++++++++++++++
 2 files changed, 17 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 70ad67c..f0c7ec8 100644
--- a/README.md
+++ b/README.md
@@ -24,22 +24,6 @@ also online at https://sbws.readthedocs.io and
 [this onion service](http://d7pxflytfsmz6uh3x7i2jxzzwea6nbpmtsz5tmfkcin5edapaig5vpyd.onion/)
 ([v2](http://sdmb3rfvp3wadu6y.onion/)).
 
-## Layout of `sbws` source code directory
-
-- `docs/` the source of the sbws documentation website.
-- `sbws/` the source code for sbws.
-- `sbws/core/` each file contains code specific to a single sbws command.
-- `sbws/lib/` complex data structures and classes useful to one or more sbws
-  commands. If you're making a new class, it probably belongs here.
-- `sbws/util/` simplier, "make life easier" collections of functions.
-- `scripts/maint/` scripts for **maint**aining sbws and doing administrative
-  things like regenerating the website or updating the AUTHORS file.
-- `scripts/tools/` misc. scripts for users of sbws.
-  performing tests with them.
-- `tests/unit/` simple little tests that don't require Tor to be running
-- `tests/integration/` more complex tests and/or tests that require Tor to be running
-- `tests/testnets/` scripts and code for running mini Tor networks locally
-
 ## License
 
 This work is in the public domain within the United States.
diff --git a/docs/source/man_sbws.rst b/docs/source/man_sbws.rst
index ef6942d..1fccb9a 100644
--- a/docs/source/man_sbws.rst
+++ b/docs/source/man_sbws.rst
@@ -64,6 +64,23 @@ $HOME/.sbws
    Default sbws home, where it stores measurement data files,
    bandwidth list files and tor process data.
 
+$HOME/.sbws/datadir
+   Default location for the raw results generated by the ``sbws scanner``.
+   Other commands (such as ``generate`` and ``stats``) read results from the
+   files in this directory.
+
+$HOME/.sbws/log
+   Default location for the logs files generated by all ``sbws`` commands,
+   when logging to a file is configured (see **sbws.ini**).
+
+$HOME/.sbws/v3bw
+   Default location for the bandwidth files generated by the command
+   ``sbws generate``. These are the files read by the Tor directory
+   authorities.
+
+$HOME/.sbws/state.dat
+   A file for storing state needed between ``sbws`` commands.
+
 $XDG_RUNTIME_DIR/sbws
   Runtime directory for the tor process launched by ``sbws``.