September 2018 - tor-commits - lists.torproject.org

[sbws/master] Remove title, add label
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit b14fd0f0cb4d384d5bef0c714e7849f0fa3a1bdb Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 15:07:02 2018 +0000 Remove title, add label --- docs/source/config.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/source/config.rst b/docs/source/config.rst index 0c80ad3..cafe5fe 100644 --- a/docs/source/config.rst +++ b/docs/source/config.rst @@ -1,5 +1,4 @@ -Simple Bandwidth Scanner Configuration Files -============================================ +.. _config_internal: How sbws configuration works internally ----------------------------------------

1 0

[sbws/master] Create page for documentation instructions
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 364390f90298af0eb7ec650014871198231c719c Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 15:04:24 2018 +0000 Create page for documentation instructions --- DOCUMENTATION.rst => docs/source/documenting.rst | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/DOCUMENTATION.rst b/docs/source/documenting.rst similarity index 59% rename from DOCUMENTATION.rst rename to docs/source/documenting.rst index 6410f2c..c610121 100644 --- a/DOCUMENTATION.rst +++ b/docs/source/documenting.rst @@ -1,4 +1,4 @@ -.. _documentation: +.. _documenting: Installing documentation dependendencies and building it --------------------------------------------------------- @@ -30,3 +30,18 @@ To build the documentation diagrams:: cd docs/ && make umlsvg The generated diagrams will be in ``docs/build/_images/``. + +To convert the ``LaTeX`` mathematical formulae to images, extra system dependencies +are needed: + +- Core and Extra Tex_ Live packages + +They are included in most distributions. In Debian install them running:: + + apt install texlive-latex-extra + + +.. _Sphinx: http://www.sphinx-doc.org +.. _recommonmark: https://recommonmark.readthedocs.io/ +.. _Pylint: https://www.pylint.org/ +.. _Tex: http://www.tug.org/texlive/acquire.html

1 0

[sbws/master] Create page for testing instructions
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 62beb662b2a4f85f6c5dfb282b222a498f4ade30 Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 15:04:10 2018 +0000 Create page for testing instructions --- TESTING.rst => docs/source/testing.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/TESTING.rst b/docs/source/testing.rst similarity index 67% rename from TESTING.rst rename to docs/source/testing.rst index a75aeaa..6a65d58 100644 --- a/TESTING.rst +++ b/docs/source/testing.rst @@ -17,3 +17,8 @@ To install them from ``sbws`` :: To run the tests:: tox + +.. _Flake8: http://flake8.pycqa.org/ +.. _pytest: https://docs.pytest.org/ +.. _tox: https://tox.readthedocs.io +.. _Coverage: https://coverage.readthedocs.io/ \ No newline at end of file

1 0

[sbws/master] Remove symlink to LICENSE, it is already mentioned
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 5caef8ff37b7821559f91d9683fba71abfc020e1 Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 15:04:46 2018 +0000 Remove symlink to LICENSE, it is already mentioned --- docs/source/LICENSE.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/source/LICENSE.md b/docs/source/LICENSE.md deleted file mode 120000 index f0608a6..0000000 --- a/docs/source/LICENSE.md +++ /dev/null @@ -1 +0,0 @@ -../../LICENSE.md \ No newline at end of file

1 0

[sbws/master] Fix term syntax
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 499ad09863657a8260c6d8d414ad35ee0dcb39ea Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 15:10:38 2018 +0000 Fix term syntax --- docs/source/faq.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/faq.rst b/docs/source/faq.rst index 07e820a..4b0f6a2 100644 --- a/docs/source/faq.rst +++ b/docs/source/faq.rst @@ -22,7 +22,7 @@ How do sbws scanner results end up in the consensus? The :term:`sbws scanner` runs continuously to gather fresh data. -The :term `sbws generate` command takes the fresh data and generates a +The :term:`sbws generate` command takes the fresh data and generates a :term:`v3bw file`. The Tor :term:`directory authority` parses the v3bw file and includes bandwidth

1 0

[sbws/master] Remove notes, add seealso
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit f27669f2c649371d61735c2702430298ad81de55 Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 15:08:42 2018 +0000 Remove notes, add seealso --- docs/source/faq.rst | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/source/faq.rst b/docs/source/faq.rst index 4a3887a..07e820a 100644 --- a/docs/source/faq.rst +++ b/docs/source/faq.rst @@ -1,10 +1,7 @@ Frequently Asked Questions (FAQ) ================================== -.. note:: even thought this questions should be answered by reading the - :doc:`specification`, here the answers should be short and clear. - -.. note:: You may also enjoy the :doc:`glossary`. +.. seealso:: :doc:`glossary`. How many hops are the circuits used to perform the measurements? ----------------------------------------------------------------

1 0

[sbws/master] Divide TOC in sections, rearange pages order
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 9b40dc1880531559007b65411d728dbdd4934bcf Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 15:15:49 2018 +0000 Divide TOC in sections, rearange pages order --- docs/source/index.rst | 49 ++++++++++++++++++++++++++++++++++--------------- 1 file changed, 34 insertions(+), 15 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 098268d..2a16343 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,40 +6,59 @@ Welcome to Simple Bandwidth Scanner's documentation! ==================================================== -Contents --------- +User main documentation +------------------------ + +Included in the +`repository root <https://gitweb.torproject.org/sbws.git//tree/>`_ +and in ``sbws`` Debian package: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - specification - config + README INSTALL DEPLOY - README - man_sbws - man_sbws.ini - CHANGELOG CONTRIBUTING + CHANGELOG AUTHORS - LICENSE + man_sbws + man_sbws.ini + +.. _dev_doc: + +Developer/technical documentation +---------------------------------- + +Included in the +`docs directory <https://gitweb.torproject.org/sbws.git/tree/docs>`_ and in +``sbws-doc`` Debian package: + +.. toctree:: + :maxdepth: 1 + + specification faq glossary - diagrams + layout + config_tor + testing + documenting state + config + diagrams sbws -Proposals ---------- +Proposals: .. toctree:: - :glob: :maxdepth: 1 + :glob: proposals/* Indices and tables -================== +------------------- * :ref:`genindex` * :ref:`modindex`

1 0

[sbws/master] Fix formula scaping latex in docstring
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 6597f3554445b57d78eebfb6beea20f60332a6fd Author: juga0 <juga(a)riseup.net> Date: Tue Sep 25 08:00:26 2018 +0000 Fix formula scaping latex in docstring --- sbws/lib/v3bwfile.py | 70 ++++++++++++++++++++++++++-------------------------- 1 file changed, 35 insertions(+), 35 deletions(-) diff --git a/sbws/lib/v3bwfile.py b/sbws/lib/v3bwfile.py index afed0b1..0bbead1 100644 --- a/sbws/lib/v3bwfile.py +++ b/sbws/lib/v3bwfile.py @@ -695,45 +695,45 @@ class V3BWFile(object): All of that can be expressed as: .. math:: - :label:torflow_bwn_eq - - bwn_i =& - max\left( - \frac{bw_i}{\mu}, - \frac{bwf_i}{\mu_{bwf}} - \right) - \times bwobs_i\\ + + bwn_i &= + max\\left( + \\frac{bw_i}{\\mu}, + \\frac{bwf_i}{\\mu_{bwf}} + \\right) + \\times bwobs_i .. math:: - bwn_i =& - max\left( - \frac{bw_i}{\mu}, - min \left( + bwn_i &= + max\\left( + \\frac{bw_i}{\\mu}, + min \\left( + bw_i, + bw_i \\times \\mu + \\right) + \\times + \\frac{bw_i}{\\sum_{i=1}^{n} + min \\left(bw_i, + bw_i \\times \\mu + \\right)} + \\right) + \\times bwobs_i \\ + + &= + max\\left( + \\frac{bw_i}{\\frac{\\sum_{i=1}^{n}bw_i}{n}}, + min \\left( bw_i, - bw_i \times \mu - \right) - \times - \frac{bw}{\sum_{i=1}^{n} - min \left(bw_i, - bw_i \times \mu - \right)} - \right) - \times bwobs_i \\ - =& - max\left( - \frac{bw_i}{\frac{\sum_{i=1}^{n}bw_i}{n}}, - min \left( - bw_i, - bw_i \times \frac{\sum_{i=1}^{n}bw_i}{n} - \right) - \times - \frac{bw}{\sum_{i=1}^{n} - min \left(bw_i, - bw_i \times \frac{\sum_{i=1}^{n}bw_i}{n} - \right)} - \right) - \times bwobs_i + bw_i \\times \\frac{\\sum_{i=1}^{n}bw_i}{n} + \\right) + \\times + \\frac{bw_i}{\\sum_{i=1}^{n} + min \\left(bw_i, + bw_i \\times \\frac{\\sum_{i=1}^{n}bw_i}{n} + \\right)} + \\right) + \\times bwobs_i """ log.info("Calculating relays' bandwidth using Torflow method.")

1 0

[sbws/master] Fix identation in docstring
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit e0cc70853e55fff7e7273aed270ea8a9417f92ef Author: juga0 <juga(a)riseup.net> Date: Tue Sep 25 09:00:06 2018 +0000 Fix identation in docstring --- sbws/lib/relaylist.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sbws/lib/relaylist.py b/sbws/lib/relaylist.py index aa197c0..58cae75 100644 --- a/sbws/lib/relaylist.py +++ b/sbws/lib/relaylist.py @@ -91,7 +91,8 @@ class Relay: """Obtain ed25519 master key of the relay in server descriptors. :returns: str, the ed25519 master key base 64 encoded without - trailing '='s. + trailing '='s. + """ # Even if this key is called master-key-ed25519 in dir-spec.txt, # it seems that stem parses it as ed25519_master_key

1 0

[sbws/master] Clarify title
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 8018bd8ed8750babf38cd715045b8c1abb0a8a27 Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 15:16:49 2018 +0000 Clarify title --- docs/source/sbws.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/sbws.rst b/docs/source/sbws.rst index 3e679e6..3c78a63 100644 --- a/docs/source/sbws.rst +++ b/docs/source/sbws.rst @@ -1,5 +1,5 @@ -Simple Bandwidth Scanner package -================================ +sbws package API +================= Subpackages -----------

1 0