tor-commits September 2018

tor-commits@lists.torproject.org

17 participants
3230 discussions

[sbws/master] Replace sbws by the full command (sbws scanner)
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit f3b06eeb265a89989488373ab5416b3f60060b6b Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 17:54:09 2018 +0000 Replace sbws by the full command (sbws scanner) --- docs/source/man_sbws.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/man_sbws.rst b/docs/source/man_sbws.rst index 1fccb9a..9d4b164 100644 --- a/docs/source/man_sbws.rst +++ b/docs/source/man_sbws.rst @@ -82,7 +82,7 @@ $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``. + Runtime directory for the tor process launched by ``sbws scanner``. SEE ALSO ---------

1 0

[sbws/master] Add section git workflow, simplify commits
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 57df2a0ab4e8f704c893ba5a79dfcd5611eb5345 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 20:07:01 2018 +0000 Add section git workflow, simplify commits the reference to how to write commit messages should be enough. --- CONTRIBUTING.rst | 45 +++++---------------------------------------- 1 file changed, 5 insertions(+), 40 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b61e220..586bc13 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -101,15 +101,13 @@ Timestamps must be in UTC. It is prefered to use ``datetime`` objects or Unix timestamps. Timestamps read by the user should be always formatted in `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_ -Git and GitHub Guidelines -========================= +Git workflow +------------ -**Write good commit messages** that at least follow the spirit of -:ref:`this example <commit-msg>`. +Commits +~~~~~~~~ -Strive to **write many small commits** each containing an atomic change instead -of one large mega-commit. This not only makes code review easier, but it also -makes commits that show up in ``git blame`` 10 years from now make more sense. +Commit messages should follow the `Tim Pope`_ recommendations. **Prefer a rebase workflow instead of merge**. Incorporating PRs should be done with fast-forward merge, if easily possible. The larger the topic branch, the @@ -125,39 +123,6 @@ may get overwritten (for example: "transient\_" prefix). Instead of overwriting a branch, add a version suffix (for example: "_02"). -.. _commit-msg: - -Example commit message -====================== - -With thanks to `Tim Pope`_: - - -:: - - Capitalized, short (50 chars or less) summary - - More detailed explanatory text, if necessary. Wrap it to about 72 - characters or so. In some contexts, the first line is treated as the - subject of an email and the rest of the text as the body. The blank - line separating the summary from the body is critical (unless you omit - the body entirely); tools like rebase can get confused if you run the - two together. - - Write your commit message in the imperative: "Fix bug" and not "Fixed bug" - or "Fixes bug." This convention matches up with commit messages generated - by commands like git merge and git revert. - - Further paragraphs come after blank lines. - - - Bullet points are okay, too - - - Typically a hyphen or asterisk is used for the bullet, followed by a - single space, with blank lines in between, but conventions vary here - - - Use a hanging indent - - .. _pull request: https://github.com/pastly/simple-bw-scanner/compare

1 0

[sbws/master] Add section about bug reports and trac
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 7663f8fb8c2c348312ece375c948c76d6894b70d Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 18:30:39 2018 +0000 Add section about bug reports and trac --- CONTRIBUTING.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index a2134e0..d7e2822 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -5,9 +5,18 @@ Thank you for your interest in Simple Bandwidth Scanner (``sbws``). Examples of contributions include: -* Bug reports +* Bug reports, feature requests * Code/documentation patches +Bug reports +------------ + +Check that bug has not been already reported. +To report bugs or request features, open a ticket in +`Tor Project Trac <https://trac.torproject.org/projects/tor/newticket>`_ +and assign the component to ``Core Tor``/``sbws``. + + Pull requests are welcome, especially if they address open issues. #. Fork the repo on GitHub

1 0

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

25 Sep '18

commit d03a71a482ee048dc768071ea86fa9740eb508f8 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 20:47:40 2018 +0000 Clarify workflow --- CONTRIBUTING.rst | 53 ++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 42 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 586bc13..ec8bdcc 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -109,22 +109,53 @@ Commits Commit messages should follow the `Tim Pope`_ recommendations. -**Prefer a rebase workflow instead of merge**. Incorporating PRs should be done -with fast-forward merge, if easily possible. The larger the topic branch, the -harder this may be, so merge commits are allowed. +Workflow +~~~~~~~~~ -If, while working on a topic branch, some changes are made to master that -conflict with your work or that you need to incorporate into your work, **do -not merge master into your topic branch**; instead, rebase your topic branch on -top of master or cherry-pick the changes. +In general, when you are modifying code that was not wrotten by yourself, +try to keep changes to the minimum. -**Do not force push lightly** unless branches are clearly labeled as ones that -may get overwritten (for example: "transient\_" prefix). Instead of overwriting -a branch, add a version suffix (for example: "_02"). +When a PR is being reviewed, new changes might be needed: +- If the change does not modify a previous change, just commit and push. +- If the change modifies a previous change and it's small, + `git commit fixup <https://git-scm.com/docs/git-commit#git-commit---fixupltcommitgt>`_ + should be used. When it is agreed that the PR is ready, create a new branch + named ``mybranch_02`` and run:: + rebase --autosquash -.. _pull request: https://github.com/pastly/simple-bw-scanner/compare + push, create new PR and close old PR mentioning the number of the new PR. +- If the review takes long and when it's ready code related to the PR has changed + in master, create a new branch named ``mybranch_02`` and run:: + + rebase master + + push, create new PR and close old PR mentioning the number of the new PR. + +Reviewers: (see :ref:`reviewers`) + +- should not push code to your branch, unless you agree +- should let you know when new changes are needed +- should not merge your PR after changes are requested and you notify you did + via the PR or the ticket. +- should not merge your PR and then inmediatly modify your code pushing + directly to master without informing you previously and without your consent. + +.. _reviewers: + +Reviewers +---------- + +At the moment, there is not any policy to decide who the reviewers are. +They are the current people that has contributed to this code: pastly, teor, +juga0. +They should not push directly to master and they should peer-review their code. +Currently, if a PR from a reviewer has not been peer-reviewd by other reviewer +in a week, the reviewer can merge their/her/his own PR. + +They should merge PR to master. Instead of rebase. If needed, rebase should be +done by the contributor before the merge. .. _tim pope: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

1 0

[sbws/master] Rephrase timestamps format
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 34e566c3ef6be9956ca20e58f010ab8c8b2a6e54 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 19:51:43 2018 +0000 Rephrase timestamps format --- CONTRIBUTING.rst | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b2b96eb..65a2349 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -93,6 +93,10 @@ Before release 1.0.0, some docstrigs do not have 3 double quotes ``"""`` New features should add a corresponding documentation. +Timestamps must be in UTC. It is prefered to use ``datetime`` objects or +Unix timestamps. Timestamps read by the user should be always formatted in +`ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_ + Git and GitHub Guidelines ========================= @@ -119,12 +123,6 @@ a branch, add a version suffix (for example: "_02"). Coding Guidelines ================= -**Strongly prefer Unix timestamps or datetime objects in UTC** and always -work in UTC for as long as possible. When reading/writing/manipulating results -from some period of time in the past, always err on the side of caution. For -example, open an extra file into the past just in case it happens to include -result lines that have timestamps that are still considered valid (of course, -ignore results in the file that are no longer valid). **Document your addition, fix, change, or whatever in the changelog**. See `keep a changelog`_ for the standard we follow. Of note, add Added, Changed,

1 0

[sbws/master] Clarify steps to submit code
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 9467ccd67aeb943b96389019ee09a4c6df085929 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 18:53:50 2018 +0000 Clarify steps to submit code --- CONTRIBUTING.rst | 37 ++++++++++++++++++++++++------------- 1 file changed, 24 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d7e2822..b109ee5 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -16,19 +16,30 @@ To report bugs or request features, open a ticket in `Tor Project Trac <https://trac.torproject.org/projects/tor/newticket>`_ and assign the component to ``Core Tor``/``sbws``. - -Pull requests are welcome, especially if they address open issues. - -#. Fork the repo on GitHub -#. Clone a copy of sbws to your machine as per - :doc:`the install instructions </INSTALL>`, but use your repo. -#. Fix that bug or implement that feature - - As part of this process, it would be appreciated (and might event help - you) if you wrote tests to catch the buggy behavior you're solving so it - won't break again. -#. Make sure all tests pass when running ``tox``. -#. Commit your changes and push them to a branch in your sbws GitHub repo -#. Open a `pull request`_ +Code/documentation patches +--------------------------- + +The sbws canonical repository is https://gitweb.torproject.org/sbws.git, +but we review patches using the Github canonical repository +(https://github.com/torproject/sbws) Pull Requests (PR). + +Steps: + +1. Create a ticket in Tor Project Trac as explained above +2. Clone ``sbws`` via the Github web interface + https://github.com/torproject/sbws +3. Clone the repository locally +4. Install ``sbws`` as explained in ./INSTALL.rst and TESTING.rst + Use ``pip install -e <>`` +5. If needed install the documentation and build it as explained in + ./DOCUMENTATION.rst +6. Create a new branch, named ``ticketXXX``. + Optionally, name it with a string explaining what it does, + ie ``ticketXXX_contributing`` +7. Write code, create tests, commit, etc. +8. Ensure tests pass. +9. Create a PR from your branch to https://github.com/torproject/sbws +10. Change the ticket status to ``needs_review`` We use flake8 to check some PEP8 errors/warnings. This will be checked with ``tox`` and Travis.

1 0

[sbws/master] Rephrase changelog documentation
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 997f5f4e366a75885b7f3f298a6e1de6b662a4a9 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 20:01:14 2018 +0000 Rephrase changelog documentation --- CONTRIBUTING.rst | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 65a2349..b61e220 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -93,6 +93,10 @@ Before release 1.0.0, some docstrigs do not have 3 double quotes ``"""`` New features should add a corresponding documentation. +Document your changes in ./CHANGELOG.rst following `keep a changelog`_. +Reference the Tor Project Trac ticket (example: ``#12345``) or +Github ticket (example: ``GH#123``). + Timestamps must be in UTC. It is prefered to use ``datetime`` objects or Unix timestamps. Timestamps read by the user should be always formatted in `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_ @@ -120,18 +124,6 @@ top of master or cherry-pick the changes. may get overwritten (for example: "transient\_" prefix). Instead of overwriting a branch, add a version suffix (for example: "_02"). -Coding Guidelines -================= - - -**Document your addition, fix, change, or whatever in the changelog**. See -`keep a changelog`_ for the standard we follow. Of note, add Added, Changed, -Deprecated, Removed, Fixed, and Security headings as needed in the Unreleased -section. **If your change has a trac or GitHub ticket, reference it** like -``(GH#123)`` or ``(trac#22104)``. When it comes time to do a release, the -person doing the release should (1) change the name of the Unreleased section -and add a new one, and (2) update the links at the bottom. - .. _commit-msg:

1 0

[sbws/master] Move building documentation to a different file
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 4075c4d725c9a2adc96a43a8dde89bd8c54c1e50 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 18:51:15 2018 +0000 Move building documentation to a different file --- DOCUMENTATION.rst | 32 ++++++++++++++++++++++++++++++++ INSTALL.rst | 31 ------------------------------- 2 files changed, 32 insertions(+), 31 deletions(-) diff --git a/DOCUMENTATION.rst b/DOCUMENTATION.rst new file mode 100644 index 0000000..6410f2c --- /dev/null +++ b/DOCUMENTATION.rst @@ -0,0 +1,32 @@ +.. _documentation: + +Installing documentation dependendencies and building it +--------------------------------------------------------- + +To build the documentation, extra Python dependencies are needed: + +- Sphinx_ +- recommonmark_ +- Pylint_ (only to update the diagrams) + +To install them from ``sbws``:: + + pip install .[doc] + +To build the documentation as HTML:: + + cd docs/ && make html + +The generated HTML will be in ``docs/build/``. + +To build the manual (``man``) pages:: + + cd docs/ && make man + +The generated man pages will be in ``docs/man/``. + +To build the documentation diagrams:: + + cd docs/ && make umlsvg + +The generated diagrams will be in ``docs/build/_images/``. diff --git a/INSTALL.rst b/INSTALL.rst index 5832f3b..5ad7875 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -48,37 +48,6 @@ Install the python dependencies:: ``sbws`` needs :term:`destination` s to request files from. Please, see :ref:`deploy` to know how to configure, deploy and run ``sbws``. -Installing documentation dependendencies and building it ---------------------------------------------------------- - -To build the documentation, extra Python dependencies are needed: - -- Sphinx_ -- recommonmark_ -- Pylint_ (only to update the diagrams) - -To install them from ``sbws``:: - - pip install .[doc] - -To build the documentation as HTML:: - - cd docs/ && make html - -The generated HTML will be in ``docs/build/``. - -To build the manual (``man``) pages:: - - cd docs/ && make man - -The generated man pages will be in ``docs/man/``. - -To build the documentation diagrams:: - - cd docs/ && make umlsvg - -The generated diagrams will be in ``docs/build/_images/``. - System physical requirements -----------------------------

1 0

[sbws/master] Update link to canonical gh repo in travis
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 0bfb913648ffe68cd7ea960bb53e566fc43b6d56 Author: juga0 <juga(a)riseup.net> Date: Mon Sep 17 14:07:25 2018 +0000 Update link to canonical gh repo in travis --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f0c7ec8..36f0bb1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Readme -[![Build Status](https://travis-ci.org/pastly/simple-bw-scanner.svg?branch=master)](… +[![Build Status](https://travis-ci.org/torproject/sbws.svg?branch=master)](https://t… `simple-bw-scanner` (also called `sbws`) is a Tor bandwidth scanner that produces bandwidth measurements files to be used by Directory Authorities.

1 0

[sbws/master] Remove section already included in sbws.ini
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit f276fffa19e11e32c9d94fd7c8465b605ec6d537 Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 09:39:21 2018 +0000 Remove section already included in sbws.ini --- docs/source/config.rst | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/docs/source/config.rst b/docs/source/config.rst index 2a0c7f9..0c80ad3 100644 --- a/docs/source/config.rst +++ b/docs/source/config.rst @@ -1,20 +1,6 @@ Simple Bandwidth Scanner Configuration Files ============================================ -How to create user customized configuration files --------------------------------------------------- -``sbws`` use internal configuration files. -These are **not** intented to be modified by a user. -If a user needs a customized configuration file, the user needs to create it. -There's an example configuration file with the minimum data that a user -probably needs to edit in ``examples``. For more advanced configuration options see -documentation below. -``sbws`` will check by default whether there's a user customized file in -``~/.sbws.ini`` and use it when it exists. -The user can store a customized configuration file anywhere else in the file -system and and provide ``sbws`` with the path to it via the ``-c`` or -``--config`` cli option. - How sbws configuration works internally ---------------------------------------- Sbws has two default config files it reads: on general, and one specific to

1 0

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

tor-commits September 2018