diff options
| author | Micah Lee <micah@micahflee.com> | 2020-08-25 17:21:35 -0700 |
|---|---|---|
| committer | Micah Lee <micah@micahflee.com> | 2020-08-25 17:21:35 -0700 |
| commit | 29db256ebaa3b4e3738cac46df01801c13c73c44 (patch) | |
| tree | 530fd5e0f951a30f4cd5ee3989f250b4208b3674 /docs/source/develop.rst | |
| parent | cae83797c6cad4c660f20dea8490643ac7233e50 (diff) | |
| download | onionshare-29db256ebaa3b4e3738cac46df01801c13c73c44.tar.gz onionshare-29db256ebaa3b4e3738cac46df01801c13c73c44.zip | |
Add getting help
Diffstat (limited to 'docs/source/develop.rst')
| -rw-r--r-- | docs/source/develop.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/source/develop.rst b/docs/source/develop.rst index 09881720..1d9ec908 100644 --- a/docs/source/develop.rst +++ b/docs/source/develop.rst @@ -1,6 +1,8 @@ Developing OnionShare ===================== +.. _collaborating: + Collaborating ------------- @@ -32,7 +34,7 @@ That file contains the technical instructions and commands necessary: Debugging Tips -------------- -Verbose Mode +Verbose mode ^^^^^^^^^^^^ When developing, it's convenient to run OnionShare from a terminal and add the ``--verbose`` (or ``-v``) flag to the command. This will print a lot of helpful messages to the terminal such as when certain objects are initialized, when events occur (like buttons clicked, settings saved or reloaded), and other debug information. For example:: @@ -121,7 +123,7 @@ You can add your own debug messages by running the ``Common.log`` method from `` This can be useful when learning the chain of events that occur when using the application or the value of certain variables before and after they are manipulated. -Local Only +Local only ^^^^^^^^^^ Tor is slow, and it's often convenient to skip starting onion services altogether during development. You can do this with the ``--local-only`` flag. For example:: |