Merge pull request #620 from aldenml/typos

Documentation typos
This commit is contained in:
Arvid Norberg 2016-04-15 17:21:13 -04:00
commit 0441ed212c
5 changed files with 24 additions and 24 deletions

View File

@ -344,7 +344,7 @@ namespace libtorrent
int upload_rate_peak; int upload_rate_peak;
// the progress of the peer in the range [0, 1]. This is always 0 when // the progress of the peer in the range [0, 1]. This is always 0 when
// floating point operations are diabled, instead use ``progress_ppm``. // floating point operations are disabled, instead use ``progress_ppm``.
float progress; // [0, 1] float progress; // [0, 1]
// indicates the download progress of the peer in the range [0, 1000000] // indicates the download progress of the peer in the range [0, 1000000]

View File

@ -135,7 +135,7 @@ namespace libtorrent
int whole_pieces_threshold; int whole_pieces_threshold;
// the number of seconds to wait for any activity on the peer wire before // the number of seconds to wait for any activity on the peer wire before
// closing the connectiong due to time out. This defaults to 120 seconds, // closing the connection due to time out. This defaults to 120 seconds,
// since that's what's specified in the protocol specification. After // since that's what's specified in the protocol specification. After
// half the time out, a keep alive message is sent. // half the time out, a keep alive message is sent.
int peer_timeout; int peer_timeout;
@ -170,7 +170,7 @@ namespace libtorrent
// connections should be rejected or not. Multiple connections from the // connections should be rejected or not. Multiple connections from the
// same IP address is not allowed by default, to prevent abusive behavior // same IP address is not allowed by default, to prevent abusive behavior
// by peers. It may be useful to allow such connections in cases where // by peers. It may be useful to allow such connections in cases where
// simulations are run on the same machie, and all peers in a swarm has // simulations are run on the same machine, and all peers in a swarm has
// the same IP address. // the same IP address.
bool allow_multiple_connections_per_ip; bool allow_multiple_connections_per_ip;
@ -280,7 +280,7 @@ namespace libtorrent
// //
// When this limit is reached, the peer connections will stop reading // When this limit is reached, the peer connections will stop reading
// data from their sockets, until the disk thread catches up. Setting // data from their sockets, until the disk thread catches up. Setting
// this too low will severly limit your download rate. // this too low will severely limit your download rate.
int max_queued_disk_bytes; int max_queued_disk_bytes;
#ifndef TORRENT_NO_DEPRECATE #ifndef TORRENT_NO_DEPRECATE
@ -497,7 +497,7 @@ namespace libtorrent
// from growing its file cache indefinitely. Since some OSes only allow // from growing its file cache indefinitely. Since some OSes only allow
// aligned files to be opened in unbuffered mode, It is recommended to // aligned files to be opened in unbuffered mode, It is recommended to
// make the largest file in a torrent the first file (with offset 0) or // make the largest file in a torrent the first file (with offset 0) or
// use pad files to align all files to piece boundries. // use pad files to align all files to piece boundaries.
int disk_io_write_mode; int disk_io_write_mode;
int disk_io_read_mode; int disk_io_read_mode;
@ -634,7 +634,7 @@ namespace libtorrent
int peer_turnover_interval; int peer_turnover_interval;
// the percentage of peers to disconnect every // the percentage of peers to disconnect every
// turnoever interval (if we're at the peer limit) // turnover interval (if we're at the peer limit)
// defaults to 4% // defaults to 4%
// this is specified in percent // this is specified in percent
float peer_turnover; float peer_turnover;
@ -760,7 +760,7 @@ namespace libtorrent
// complete and needs to be verified against the piece hash. This happens // complete and needs to be verified against the piece hash. This happens
// if some blocks were flushed to the disk out of order. Everything that // if some blocks were flushed to the disk out of order. Everything that
// is flushed in order is hashed as it goes along. Optimizing for speed // is flushed in order is hashed as it goes along. Optimizing for speed
// will allocate space to fit all the the remaingin, unhashed, part of // will allocate space to fit all the remaining, unhashed, part of
// the piece, reads the data into it in a single call and hashes it. This // the piece, reads the data into it in a single call and hashes it. This
// is the default. If ``optimizing_hashing_for_speed`` is false, a single // is the default. If ``optimizing_hashing_for_speed`` is false, a single
// block will be allocated (16 kB), and the unhashed parts of the piece // block will be allocated (16 kB), and the unhashed parts of the piece
@ -785,7 +785,7 @@ namespace libtorrent
lru, lru,
// will flush the largest sequences of contiguous blocks from the // will flush the largest sequences of contiguous blocks from the
// write cache, regarless of the piece's last use time. // write cache, regardless of the piece's last use time.
largest_contiguous, largest_contiguous,
// will prioritize flushing blocks that will avoid having to read them // will prioritize flushing blocks that will avoid having to read them
@ -802,7 +802,7 @@ namespace libtorrent
// the number of blocks to read into the read cache when a read cache // the number of blocks to read into the read cache when a read cache
// miss occurs. Setting this to 0 is essentially the same thing as // miss occurs. Setting this to 0 is essentially the same thing as
// disabling read cache. The number of blocks read into the read cache is // disabling read cache. The number of blocks read into the read cache is
// always capped by the piece boundry. // always capped by the piece boundary.
// //
// When a piece in the write cache has ``write_cache_line_size`` // When a piece in the write cache has ``write_cache_line_size``
// contiguous blocks in it, they will be flushed. Setting this to 1 // contiguous blocks in it, they will be flushed. Setting this to 1
@ -929,7 +929,7 @@ namespace libtorrent
// waste finding the true reciprocation rate. // waste finding the true reciprocation rate.
int default_est_reciprocation_rate; int default_est_reciprocation_rate;
// specifies how many percent the extimated reciprocation rate should be // specifies how many percent the estimated reciprocation rate should be
// increased by each unchoke interval a peer is still choking us back. // increased by each unchoke interval a peer is still choking us back.
// This defaults to 20%. This only applies to the BitTyrant choker. // This defaults to 20%. This only applies to the BitTyrant choker.
int increase_est_reciprocation_rate; int increase_est_reciprocation_rate;
@ -950,8 +950,8 @@ namespace libtorrent
bool incoming_starts_queued_torrents; bool incoming_starts_queued_torrents;
// when set to true, the downloaded counter sent to trackers will include // when set to true, the downloaded counter sent to trackers will include
// the actual number of payload bytes donwnloaded including redundant // the actual number of payload bytes downloaded including redundant
// bytes. If set to false, it will not include any redundany bytes // bytes. If set to false, it will not include any redundancy bytes
bool report_true_downloaded; bool report_true_downloaded;
// defaults to true, and controls when a block may be requested twice. If // defaults to true, and controls when a block may be requested twice. If
@ -981,7 +981,7 @@ namespace libtorrent
// the max number of peers we accept from pex messages from a single peer. // the max number of peers we accept from pex messages from a single peer.
// this limits the number of concurrent peers any of our peers claims to // this limits the number of concurrent peers any of our peers claims to
// be connected to. If they clain to be connected to more than this, we'll // be connected to. If they claim to be connected to more than this, we'll
// ignore any peer that exceeds this limit // ignore any peer that exceeds this limit
int max_pex_peers; int max_pex_peers;
@ -998,7 +998,7 @@ namespace libtorrent
// determines if the storage should check the whole files when resume // determines if the storage should check the whole files when resume
// data is incomplete or missing or whether it should simply assume we // data is incomplete or missing or whether it should simply assume we
// don't have any of the data. By default, this is determined by the // don't have any of the data. By default, this is determined by the
// existance of any of the files. By setting this setting to true, the // existence of any of the files. By setting this setting to true, the
// files won't be checked, but will go straight to download mode. // files won't be checked, but will go straight to download mode.
bool no_recheck_incomplete_resume; bool no_recheck_incomplete_resume;
@ -1216,7 +1216,7 @@ namespace libtorrent
bool seeding_outgoing_connections; bool seeding_outgoing_connections;
// if true (which is the default), libtorrent will not connect to any // if true (which is the default), libtorrent will not connect to any
// peers on priviliged ports (<= 1023). This can mitigate using // peers on privileged ports (<= 1023). This can mitigate using
// bittorrent swarms for certain DDoS attacks. // bittorrent swarms for certain DDoS attacks.
bool no_connect_privileged_ports; bool no_connect_privileged_ports;
@ -1233,7 +1233,7 @@ namespace libtorrent
// second may be limited to below the ``connection_speed``, in case we're // second may be limited to below the ``connection_speed``, in case we're
// close to bump up against the limit of number of connections. The // close to bump up against the limit of number of connections. The
// intention of this setting is to more evenly distribute our connection // intention of this setting is to more evenly distribute our connection
// attempts over time, instead of attempting to connectin in batches, and // attempts over time, instead of attempting to connect in batches, and
// timing them out in batches. // timing them out in batches.
bool smooth_connects; bool smooth_connects;

View File

@ -213,7 +213,7 @@ namespace libtorrent
// connections should be rejected or not. Multiple connections from // connections should be rejected or not. Multiple connections from
// the same IP address is not allowed by default, to prevent abusive // the same IP address is not allowed by default, to prevent abusive
// behavior by peers. It may be useful to allow such connections in // behavior by peers. It may be useful to allow such connections in
// cases where simulations are run on the same machie, and all peers // cases where simulations are run on the same machine, and all peers
// in a swarm has the same IP address. // in a swarm has the same IP address.
allow_multiple_connections_per_ip = bool_type_base, allow_multiple_connections_per_ip = bool_type_base,

View File

@ -215,7 +215,7 @@ namespace libtorrent
// made synchronously. This means it has to wait for the main thread to // made synchronously. This means it has to wait for the main thread to
// complete the query before it can return. This might potentially be // complete the query before it can return. This might potentially be
// expensive if done from within a GUI thread that needs to stay // expensive if done from within a GUI thread that needs to stay
// responsive. Try to avoid quering for information you don't need, and // responsive. Try to avoid querying for information you don't need, and
// try to do it in as few calls as possible. You can get most of the // try to do it in as few calls as possible. You can get most of the
// interesting information about a torrent from the // interesting information about a torrent from the
// torrent_handle::status() call. // torrent_handle::status() call.
@ -227,7 +227,7 @@ namespace libtorrent
// //
// .. warning:: // .. warning::
// All operations on a torrent_handle may throw libtorrent_exception // All operations on a torrent_handle may throw libtorrent_exception
// exception, in case the handle is no longer refering to a torrent. // exception, in case the handle is no longer referring to a torrent.
// There is one exception is_valid() will never throw. Since the torrents // There is one exception is_valid() will never throw. Since the torrents
// are processed by a background thread, there is no guarantee that a // are processed by a background thread, there is no guarantee that a
// handle will remain valid between two calls. // handle will remain valid between two calls.
@ -285,7 +285,7 @@ namespace libtorrent
// specified piece before calling this function. // specified piece before calling this function.
// //
// When the read operation is completed, it is passed back through an // When the read operation is completed, it is passed back through an
// alert, read_piece_alert. Since this alert is a reponse to an explicit // alert, read_piece_alert. Since this alert is a response to an explicit
// call, it will always be posted, regardless of the alert mask. // call, it will always be posted, regardless of the alert mask.
// //
// Note that if you read multiple pieces, the read operations are not // Note that if you read multiple pieces, the read operations are not
@ -397,7 +397,7 @@ namespace libtorrent
// To query the priority of a torrent, use the // To query the priority of a torrent, use the
// ``torrent_handle::status()`` call. // ``torrent_handle::status()`` call.
// //
// Torrents with higher priority will not nececcarily get as much // Torrents with higher priority will not necessarily get as much
// bandwidth as they can consume, even if there's is more quota. Other // bandwidth as they can consume, even if there's is more quota. Other
// peers will still be weighed in when bandwidth is being distributed. // peers will still be weighed in when bandwidth is being distributed.
// With other words, bandwidth is not distributed strictly in order of // With other words, bandwidth is not distributed strictly in order of
@ -709,7 +709,7 @@ namespace libtorrent
// resume data saved when they complete and on exit, since their // resume data saved when they complete and on exit, since their
// statistics might be updated. // statistics might be updated.
// //
// In full allocation mode the reume data is never invalidated by // In full allocation mode the resume data is never invalidated by
// subsequent writes to the files, since pieces won't move around. This // subsequent writes to the files, since pieces won't move around. This
// means that you don't need to pause before writing resume data in full // means that you don't need to pause before writing resume data in full
// or sparse mode. If you don't, however, any data written to disk after // or sparse mode. If you don't, however, any data written to disk after
@ -835,7 +835,7 @@ namespace libtorrent
#ifndef TORRENT_NO_DEPRECATE #ifndef TORRENT_NO_DEPRECATE
// deprecated in 1.1 // deprecated in 1.1
// Sets or gets the flag that derermines if countries should be resolved // Sets or gets the flag that determines if countries should be resolved
// for the peers of this torrent. It defaults to false. If it is set to // for the peers of this torrent. It defaults to false. If it is set to
// true, the peer_info structure for the peers in this torrent will have // true, the peer_info structure for the peers in this torrent will have
// their ``country`` member set. See peer_info for more information on // their ``country`` member set. See peer_info for more information on

View File

@ -172,7 +172,7 @@ namespace libtorrent
|| (e.mode & file::random_access) != (m & file::random_access)) || (e.mode & file::random_access) != (m & file::random_access))
{ {
// close the file before we open it with // close the file before we open it with
// the new read/write privilages, since windows may // the new read/write privileges, since windows may
// file opening a file twice. However, since there may // file opening a file twice. However, since there may
// be outstanding operations on it, we can't close the // be outstanding operations on it, we can't close the
// file, we can only delete our reference to it. // file, we can only delete our reference to it.