Skip to content

Commit

Permalink
markup: consistency in enum lists, and some other minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
pyroscope committed Jun 3, 2018
1 parent 11ade75 commit cf75d90
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 39 deletions.
37 changes: 19 additions & 18 deletions docs/include-cmd-bt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ See the Github wiki for an example of `enabling DHT in rTorrent`_.

Possible values are:

- ``on`` – start DHT immediately
- ``off`` – do not start DHT
- ``auto`` – start and stop DHT as needed
- ``disable`` – completely disable DHT
* ``on`` – Start DHT immediately.
* ``off`` – Do not start DHT.
* ``auto`` – Start and stop DHT as needed.
* ``disable`` – Completely disable DHT.

dht.port
dht.port.set
Expand Down Expand Up @@ -151,22 +151,23 @@ See the Github wiki for an example of `enabling DHT in rTorrent`_.

Possible values for ``value`` are:

- ``0`` – Off
- ``1`` – MAdvise
- ``2`` – Direct page
* ``0`` – off
* ``1`` – madvise
* ``2`` – direct page

Off means it doesn't do any preloading at all.

MAdvise means it calls `madvise`_ on the file for the specific mmap'ed memory range,
`madvise` means it calls `madvise`_ on the file for the specific ``mmap``'ed memory range,
which tells the kernel to load it in memory when it gets around to it.
Which is hopefully before *rTorrent* writes to the network socket.
Which is hopefully before `rTorrent` writes to the network socket.

Direct paging means it touches each file page in order to force the kernel to load it into
memory. This can help if you're dealing with very large number of peers and large/many files,
especially in a low-memory setting, as you can avoid thrashing the disk where loaded file
pages get thrown out before they manage to get sent.

Adapted from https://github.com/rakshasa/rtorrent/issues/418#issuecomment-211335027
| *Adapted from*
| https://github.com/rakshasa/rtorrent/issues/418#issuecomment-211335027
pieces.stats_not_preloaded
pieces.stats_preloaded
Expand Down Expand Up @@ -284,14 +285,14 @@ See the Github wiki for an example of `enabling DHT in rTorrent`_.
RC4 encryption (encrypts the entire header and message, at the cost of a few CPU cycles),
with flags to control the behavior of both.

- ``none`` – The default, don't attempt any encryption
- ``allow_incoming`` – Allow incoming encrypted connections from other peers
- ``try_outgoing`` – Attempt to set up encryption when initiating a connection
- ``require`` – Require encryption, and reject peers who don't support it
- ``require_RC4`` – Require RC4 encryption specifically
- ``require_rc4`` – Same as above
- ``enable_retry`` – If a peer is rejected for not supporting the encryption we need, retry the handshake
- ``prefer_plaintext`` – Prefer plaintext encryption
* ``none`` – The default, don't attempt any encryption.
* ``allow_incoming`` – Allow incoming encrypted connections from other peers.
* ``try_outgoing`` – Attempt to set up encryption when initiating a connection.
* ``require`` – Require encryption, and reject peers who don't support it.
* ``require_RC4`` – Require RC4 encryption specifically.
* ``require_rc4`` – Same as above.
* ``enable_retry`` – If a peer is rejected for not supporting the encryption we need, retry the handshake.
* ``prefer_plaintext`` – Prefer plaintext encryption.

See `BitTorrent protocol encryption`_ for more information.

Expand Down
36 changes: 18 additions & 18 deletions docs/include-cmd-items.rst
Original file line number Diff line number Diff line change
Expand Up @@ -519,13 +519,13 @@ When called within configuration methods or in a ``Ctrl-X`` prompt, the target i
Returns an integer denoting the state of the hash process. The possible values are:

- ``0``: No hashing is happening
- ``1``: The very first hash check is occurring
- ``2``: If :term:`pieces.hash.on_completion` is enabled, the torrent is in the middle
of hashing due to the finish event, and at the end, will be checked for completeness
- ``3``: A rehash is occurring (i.e. the torrent has already been marked as complete once)
* ``0``No hashing is happening.
* ``1``The very first hash check is occurring.
* ``2``If :term:`pieces.hash.on_completion` is enabled, the torrent is in the
middle of hashing due to the finish event, and at the end, will be checked for completeness.
* ``3``A rehash is occurring (i.e. the torrent has already been marked as complete once).

See also: :term:`d.is_hash_checking`
See also :term:`d.is_hash_checking`.

d.hashing_failed
d.hashing_failed.set
Expand Down Expand Up @@ -734,10 +734,10 @@ When called within configuration methods or in a ``Ctrl-X`` prompt, the target i
Controls the priority of the item. The possible settings (and the associated value)
are as follows:

- ``0`` - off
- ``1`` - low
- ``2`` - normal
- ``3`` - high
* ``0`` off
* ``1`` low
* ``2`` normal
* ``3`` high

d.ratio

Expand Down Expand Up @@ -777,10 +777,10 @@ When called within configuration methods or in a ``Ctrl-X`` prompt, the target i
Returns the various size attributes of an item.

- **bytes**: The total number of bytes in the item's files.
- **chunks**: The number of chunks, including the trailing chunk.
- **files**: The number of files (does not include directories).
- **pex**: The number of peers that were reported via the PEX extension.
* **bytes** The total number of bytes in the item's files.
* **chunks** The number of chunks, including the trailing chunk.
* **files** The number of files (does not include directories).
* **pex** The number of peers that were reported via the PEX extension.
If :term:`d.is_pex_active` is false, this will be always be 0.

d.skip.rate
Expand Down Expand Up @@ -1114,10 +1114,10 @@ Example:
There are 3 possible priorities for files:

- ``0``: Off, do not download this file. Note that the file can still show up if there is an overlapping chunk
with a file that you do want to download
- ``1``: Normal, download this file normal
- ``2``: High, prioritize requesting chunks for this file above normal files.
* ``0`` off – Do not download this file. Note that the file can still show up
if there is an overlapping chunk with a file that you do want to download.
* ``1`` normal – Download this file normally.
* ``2`` high – Prioritize requesting chunks for this file above normal files.

In the ncurses file view, you can rotate a selected file between these states with the space bar.

Expand Down
6 changes: 3 additions & 3 deletions docs/include-cmd-network.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,9 +186,9 @@
Set the XMLRPC dialect to use, as defined by ``xmlrpc-c``.
The ``dialect`` parameter can have these values:

- 0: ``dialect_generic``
- 1: ``dialect_i8``
- 2: ``dialect_apache``
* 0 – ``dialect_generic``
* 1 – ``dialect_i8``
* 2 – ``dialect_apache``

``dialect_i8`` is the default value, which means the XMLRPC API will use the
`xmlrpc-c i8 extension type <http://xmlrpc-c.sourceforge.net/doc/libxmlrpc.html#extensiontype>`_
Expand Down

0 comments on commit cf75d90

Please sign in to comment.