From 2f8a0240f1efad10f838dcca8c0692c3e0fa4c3e Mon Sep 17 00:00:00 2001 From: Bruce Mitchener Date: Fri, 20 Apr 2018 00:49:22 +0700 Subject: [PATCH 001/225] Fix some typos. --- bindings/go/src/fdb/database.go | 4 ++-- documentation/sphinx/source/administration.rst | 4 ++-- documentation/sphinx/source/backups.rst | 16 ++++++++-------- documentation/sphinx/source/building-cluster.rst | 2 +- .../sphinx/source/command-line-interface.rst | 6 +++--- documentation/sphinx/source/configuration.rst | 2 +- documentation/sphinx/source/release-notes.rst | 8 ++++---- documentation/sphinx/source/time-series.rst | 2 +- documentation/sphinx/source/tls.rst | 4 ++-- fdbserver/DataDistribution.actor.cpp | 2 +- fdbserver/sqlite/sqlite3.amalgamation.c | 12 ++++++------ flow/TDMetric.actor.h | 4 ++-- flow/stacktrace.amalgamation.cpp | 4 ++-- 13 files changed, 35 insertions(+), 35 deletions(-) diff --git a/bindings/go/src/fdb/database.go b/bindings/go/src/fdb/database.go index b8a37bda5cc..6d793fefaf5 100644 --- a/bindings/go/src/fdb/database.go +++ b/bindings/go/src/fdb/database.go @@ -111,7 +111,7 @@ func retryable(wrapped func() (interface{}, error), onError func(Error) FutureNi // retried or, if fatal, return the error to the caller. // // When working with Future objects in a transactional function, you may either -// explicity check and return error values using Get, or call MustGet. Transact +// explicitly check and return error values using Get, or call MustGet. Transact // will recover a panicked Error and either retry the transaction or return the // error. // @@ -151,7 +151,7 @@ func (d Database) Transact(f func(Transaction) (interface{}, error)) (interface{ // retried or, if fatal, return the error to the caller. // // When working with Future objects in a read-only transactional function, you -// may either explicity check and return error values using Get, or call +// may either explicitly check and return error values using Get, or call // MustGet. ReadTransact will recover a panicked Error and either retry the // transaction or return the error. // diff --git a/documentation/sphinx/source/administration.rst b/documentation/sphinx/source/administration.rst index 83e8055b455..ef922d4c99c 100644 --- a/documentation/sphinx/source/administration.rst +++ b/documentation/sphinx/source/administration.rst @@ -121,7 +121,7 @@ The cluster file contains a connection string consisting of a cluster identifier Together the ``description`` and the ``ID`` should uniquely identify a FoundationDB cluster. -A cluster file may contain comments, marked by the ``#`` character. All characters on a line after the first occurance of a ``#`` will be ignored. +A cluster file may contain comments, marked by the ``#`` character. All characters on a line after the first occurrence of a ``#`` will be ignored. Generally, a cluster file should not be modified manually. Incorrect modifications after a cluster is created could result in data loss. To change the set of coordination servers used by a cluster, see :ref:`configuration-choosing-coordination-servers`. To change the cluster ``description``, see :ref:`configuration-setting-cluster-description`. @@ -186,7 +186,7 @@ To temporarily or permanently remove one or more machines from a FoundationDB cl It is now safe to remove these machines or processes from the cluster. - ``exclude`` can be used to exclude either machines (by specifiying an IP address) or individual processes (by specificying an ``IP``:``PORT`` pair). + ``exclude`` can be used to exclude either machines (by specifying an IP address) or individual processes (by specifying an ``IP``:``PORT`` pair). .. note:: Addresses have the form ``IP``:``PORT``. This form is used even if TLS is enabled. diff --git a/documentation/sphinx/source/backups.rst b/documentation/sphinx/source/backups.rst index 2a72530936b..0608a62c80f 100644 --- a/documentation/sphinx/source/backups.rst +++ b/documentation/sphinx/source/backups.rst @@ -48,7 +48,7 @@ There are 5 command line tools for working with Backup and DR operations: The backup agent is a daemon that actually executes the work of the backup and restore jobs. Any number of backup agents pointed at the same database will cooperate to perform backups and restores. The Backup URL specified for a backup or restore must be accessible by all ``backup_agent`` processes. ``fdbdr`` - This command line tool is used to control (but not execute) DR jobs - backups from one database to anothher. It can ``start``, ``abort`` a DR job, or ``switch`` the DR direction. It can also get the ``status`` of a running DR job. + This command line tool is used to control (but not execute) DR jobs - backups from one database to another. It can ``start``, ``abort`` a DR job, or ``switch`` the DR direction. It can also get the ``status`` of a running DR job. ``dr_agent`` The database backup agent is a daemon that actually executes the work of the DR jobs, writing snapshot and log data to the destination database. Any number of agents pointed at the same databases will cooperate to perform the backup. @@ -193,7 +193,7 @@ The ``start`` subcommand is used to start a backup. If there is already a backu Perform the backup continuously rather than terminating once a restorable backup is achieved. Database mutations within the backup's target key ranges will be continuously written to the backup as well as repeated inconsistent snapshots at the configured snapshot rate. ``-s `` or ``--snapshot_interval `` - Specifies the duration, in seconds, of the inconsistent snapshots written to the backup in continous mode. The default is 864000 which is 10 days. + Specifies the duration, in seconds, of the inconsistent snapshots written to the backup in continuous mode. The default is 864000 which is 10 days. ``-w`` Wait for the backup to complete with behavior identical to that of the :ref:`wait command `. @@ -222,7 +222,7 @@ The ``abort`` subcommand is used to abort a backup that is currently in progress ``discontinue`` --------------- -The ``discontinue`` subcommand is only available for backups that were started with the continuous (``-z``) option. Its effect is to discontinue the continous backup. Note that the subcommand does *not* abort the backup; it simply allows the backup to complete as a noncontinuous backup would. +The ``discontinue`` subcommand is only available for backups that were started with the continuous (``-z``) option. Its effect is to discontinue the continuous backup. Note that the subcommand does *not* abort the backup; it simply allows the backup to complete as a noncontinuous backup would. :: @@ -287,7 +287,7 @@ The expiration CUTOFF must be specified by one of the two following arguments: ``--expire_before_version `` Specifies the cutoff by a database commit version. -Optionally, the user can specify a minimum RESTORABILITY guarauntee with one of the following options. +Optionally, the user can specify a minimum RESTORABILITY guarantee with one of the following options. ``--restorable_after_timestamp `` Specifies that the backup must be restorable to DATETIME and later. Requires a cluster file and will use version/timestamp metadata in the database to convert DATETIME to a database commit version. DATETIME must be in the form "YYYY-MM-DD.HH:MI:SS" in UTC. @@ -371,7 +371,7 @@ The ``start`` command will start a new restore on the specified (or default) tag Required. Specifies the Backup URL for the source backup data to restore to the database. The source data must be accessible by the ``backup_agent`` processes for the cluster. ``-w`` - Wait for the the restore to reach a final state (such as complete) before exiting. Prints a progress update every few seconds. Behavior is identical to that of the wait command. + Wait for the restore to reach a final state (such as complete) before exiting. Prints a progress update every few seconds. Behavior is identical to that of the wait command. ``-k `` Specify list of key ranges from the backup to restore to the database @@ -443,7 +443,7 @@ The ``fdbdr`` command line tool is used to manage DR tasks. user@host$ fdbdr [-h] [] -d -s [-v] -The following arguments are used by mutiple subcommands: +The following arguments are used by multiple subcommands: ``-h`` Get help on the ``fdbdr`` command. @@ -452,7 +452,7 @@ The following arguments are used by mutiple subcommands: Get the version of FoundationDB in use. ``-d `` - Specify the path to the ``fdb.cluster`` file for the destination cluster of the DR operaiton. + Specify the path to the ``fdb.cluster`` file for the destination cluster of the DR operation. ``-s `` Specify the path to the ``fdb.cluster`` file for the source cluster of the DR operation. @@ -515,7 +515,7 @@ Unlike ``backup_agent``, ``dr_agent`` is not started automatically in a default Get the version of FoundationDB in use. ``-d `` - Specify the path to the ``fdb.cluster`` file for the destination cluster of the DR operaiton. + Specify the path to the ``fdb.cluster`` file for the destination cluster of the DR operation. ``-s `` Specify the path to the ``fdb.cluster`` file for the source cluster of the DR operation. diff --git a/documentation/sphinx/source/building-cluster.rst b/documentation/sphinx/source/building-cluster.rst index c89e2a614aa..0f72fd9443c 100644 --- a/documentation/sphinx/source/building-cluster.rst +++ b/documentation/sphinx/source/building-cluster.rst @@ -148,7 +148,7 @@ There is also a convenience option, ``coordinators auto``, that will automatical .. note:: |coordinators-auto| -You can also change the cluster ``description``, as decribed in :ref:`configuration-setting-cluster-description`. +You can also change the cluster ``description``, as described in :ref:`configuration-setting-cluster-description`. Next steps ========== diff --git a/documentation/sphinx/source/command-line-interface.rst b/documentation/sphinx/source/command-line-interface.rst index b4805ca57ba..dd32ef85425 100644 --- a/documentation/sphinx/source/command-line-interface.rst +++ b/documentation/sphinx/source/command-line-interface.rst @@ -74,7 +74,7 @@ Redundancy modes define storage requirements, required cluster size, and resilie * ``three_data_hall`` * ``three_datacenter`` -For descriptions of redundacy modes, see :ref:`configuration-choosing-redundancy-mode`. +For descriptions of redundancy modes, see :ref:`configuration-choosing-redundancy-mode`. storage engine ^^^^^^^^^^^^^^^ @@ -108,7 +108,7 @@ The ``coordinators`` command is used to change cluster coordinators or descripti Addresses may be specified as a list of IP:port pairs (such as ``coordinators 10.0.0.1:4000 10.0.0.2:4000 10.0.0.3:4000``). If addresses are specified, the coordinators will be set to them. An ``fdbserver`` process must be running on each of the specified addresses. -If ``auto`` is specified, coordinator addresses will be choosen automatically to support the configured redundancy level. (If the current set of coordinators are healthy and already support the configured redundancy level, nothing will be changed.) +If ``auto`` is specified, coordinator addresses will be chosen automatically to support the configured redundancy level. (If the current set of coordinators are healthy and already support the configured redundancy level, nothing will be changed.) For more information on setting coordinators, see :ref:`configuration-changing-coordination-servers`. @@ -194,7 +194,7 @@ The following options are available for use with the ``option`` command: ``READ_AHEAD_DISABLE`` - Disables read-ahead caching for range reads. Under normal operation, a transaction will read extra rows from the database into cache if range reads are used to page through a series of data one row at a time (i.e. if a range read with a one row limit is followed by another one row range read starting immediately after the result of the first). -``READ_YOUR_WRITES_DISABLE`` - Reads performed by a transaction will not see any prior mutations that occured in that transaction, instead seeing the value which was in the database at the transaction's read version. This option may provide a small performance benefit for the client, but also disables a number of client-side optimizations which are beneficial for transactions which tend to read and write the same keys within a single transaction. +``READ_YOUR_WRITES_DISABLE`` - Reads performed by a transaction will not see any prior mutations that occurred in that transaction, instead seeing the value which was in the database at the transaction's read version. This option may provide a small performance benefit for the client, but also disables a number of client-side optimizations which are beneficial for transactions which tend to read and write the same keys within a single transaction. ``RETRY_LIMIT`` - Set a maximum number of retries after which additional calls to ``onError`` will throw the most recently seen error code. Valid parameter values are ``[-1, INT_MAX]``. If set to -1, will disable the retry limit. Like all transaction options, the retry limit must be reset after a call to ``onError``. This behavior allows the user to make the retry limit dynamic. diff --git a/documentation/sphinx/source/configuration.rst b/documentation/sphinx/source/configuration.rst index c05f7d2ed9c..38e739c1b68 100644 --- a/documentation/sphinx/source/configuration.rst +++ b/documentation/sphinx/source/configuration.rst @@ -257,7 +257,7 @@ Contains default parameters for all fdbserver processes on this machine. These s * ``maxlogssize``: Delete the oldest log file when the total size of all log files exceeds the specified size. If set to 0B, old log files will not be deleted. The default value is 100MiB. * ``class``: Process class specifying the roles that will be taken in the cluster. Recommended options are ``storage``, ``transaction``, ``stateless``. See :ref:`guidelines-process-class-config` for process class config recommendations. * ``memory``: Maximum memory used by the process. The default value is 8GiB. When specified without a unit, MiB is assumed. This parameter does not change the memory allocation of the program. Rather, it sets a hard limit beyond which the process will kill itself and be restarted. The default value of 8GiB is double the intended memory usage in the default configuration (providing an emergency buffer to deal with memory leaks or similar problems). It is *not* recommended to decrease the value of this parameter below its default value. It may be *increased* if you wish to allocate a very large amount of storage engine memory or cache. In particular, when the ``storage_memory`` parameter is increased, the ``memory`` parameter should be increased by an equal amount. -* ``storage_memory``: Maximum memory used for data storage. This paramenter is used *only* with memory storage engine, not the ssd storage engine. The default value is 1GiB. When specified without a unit, MB is assumed. Clusters will be restricted to using this amount of memory per process for purposes of data storage. Memory overhead associated with storing the data is counted against this total. If you increase the ``storage_memory``, you should also increase the ``memory`` parameter by the same amount. +* ``storage_memory``: Maximum memory used for data storage. This parameter is used *only* with memory storage engine, not the ssd storage engine. The default value is 1GiB. When specified without a unit, MB is assumed. Clusters will be restricted to using this amount of memory per process for purposes of data storage. Memory overhead associated with storing the data is counted against this total. If you increase the ``storage_memory``, you should also increase the ``memory`` parameter by the same amount. * ``locality_machineid``: Machine identifier key. All processes on a machine should share a unique id. By default, processes on a machine determine a unique id to share. This does not generally need to be set. * ``locality_zoneid``: Zone identifier key. Processes that share a zone id are considered non-unique for the purposes of data replication. If unset, defaults to machine id. * ``locality_dcid``: Data center identifier key. All processes physically located in a data center should share the id. No default value. If you are depending on data center based replication this must be set on all processes. diff --git a/documentation/sphinx/source/release-notes.rst b/documentation/sphinx/source/release-notes.rst index b2aa1e7903f..e71d167db7a 100644 --- a/documentation/sphinx/source/release-notes.rst +++ b/documentation/sphinx/source/release-notes.rst @@ -16,7 +16,7 @@ Fixes Fixes ----- -* Expiring a backup could cause the fdbbackup process to hang indefinately. +* Expiring a backup could cause the fdbbackup process to hang indefinitely. 5.1.5 ===== @@ -103,7 +103,7 @@ Features * The behavior of atomic "and" and "min" operations has changed when the key doesn't exist in the database. If the key is not present, then an "and" or "min" is now equivalent to a set. * Exception messages are more descriptive. * Clients can view a sample of committed mutations. -* When switching to a DR cluster, the commit verisons on that cluster will be higher than the versions on the primary cluster. +* When switching to a DR cluster, the commit versions on that cluster will be higher than the versions on the primary cluster. * Added a read-only lock aware transaction option. * Automatically suppress trace log events which occur too frequently. * Added a new ``multi_dc`` replication mode designed for cross data center deployments. @@ -122,7 +122,7 @@ Performance * Excluded servers no longer take on stateless roles. * Stateless roles will be proactively moved off of excluded processes. * Dramatically improved restore speeds of large disk queue files. -* Clients get key location information directly from the proxies, sigificantly reducing the latency of worst case read patterns. +* Clients get key location information directly from the proxies, significantly reducing the latency of worst case read patterns. * Reduced the amount of work incompatible clients generate for coordinators and the cluster controller. In particular, this reduces the load on the cluster caused by using the multi-version client. * Pop partially recovered mutations from the transaction log to save disk space after multiple successive recoveries. * Stopped using network checksums when also using TLS. @@ -136,7 +136,7 @@ Fixes * Exclude considered the free space of non-storage processes when determining if an exclude was safe. * ``fdbmonitor`` failed to start processes after fork failure. * ``fdbmonitor`` will only stop processes when the configuration file is deleted if ``kill_on_configuration_change`` is set. -* The data distribution algorithm would hang indefinately when asked to build storage teams with more than three servers. +* The data distribution algorithm would hang indefinitely when asked to build storage teams with more than three servers. * Mutations from a restore could continue to be applied for a very short amount of time after a restore was successfully aborted. Extremely Rare Bug Fixes diff --git a/documentation/sphinx/source/time-series.rst b/documentation/sphinx/source/time-series.rst index 51021b7617f..33d6e3720b6 100644 --- a/documentation/sphinx/source/time-series.rst +++ b/documentation/sphinx/source/time-series.rst @@ -18,7 +18,7 @@ We have a number of customers, ranging from network analytics providers to VoIP/ Time-series Data and FoundationDB ================================= -If you only have a few fields to store per database record, it’s pretty simple to picture what a time-oriented record would look like. If you were tracking analytics for a website, you might have a few fields, such as a website identifer, a page identfier, and a browser type. That’s pretty simple to picture fitting into a defined, relational-database table that looks like this: +If you only have a few fields to store per database record, it’s pretty simple to picture what a time-oriented record would look like. If you were tracking analytics for a website, you might have a few fields, such as a website identifier, a page identifier, and a browser type. That’s pretty simple to picture fitting into a defined, relational-database table that looks like this: ============= ========== ======= ========== Timestamp website_ID page_ID browser_ID diff --git a/documentation/sphinx/source/tls.rst b/documentation/sphinx/source/tls.rst index 7e3e5dc0dec..c93dc74aa95 100644 --- a/documentation/sphinx/source/tls.rst +++ b/documentation/sphinx/source/tls.rst @@ -63,7 +63,7 @@ Command-line Option Client Option Environment Variable Purpo The value for each setting can be specified in more than one way. The actual valued used is determined in the following order: -1. An explicity specified value as a command-line option or client option, if one is given; +1. An explicitly specified value as a command-line option or client option, if one is given; 2. The value of the environment variable, if one has been set; 3. The default value @@ -194,7 +194,7 @@ Setting Result Adding verification requirements ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Requirements can be placed on the fields of the Issuer and Subject DNs in the peer's own certificate. These reqirements take the form of a comma-separated list of conditions. Each condition takes the form of ``field=value``. Only certain fields from a DN can be matched against. +Requirements can be placed on the fields of the Issuer and Subject DNs in the peer's own certificate. These requirements take the form of a comma-separated list of conditions. Each condition takes the form of ``field=value``. Only certain fields from a DN can be matched against. ====== =================== Field Well known name diff --git a/fdbserver/DataDistribution.actor.cpp b/fdbserver/DataDistribution.actor.cpp index eedaac2fc56..f1f8fd3b36c 100644 --- a/fdbserver/DataDistribution.actor.cpp +++ b/fdbserver/DataDistribution.actor.cpp @@ -214,7 +214,7 @@ class TCTeamInfo : public ReferenceCounted, public IDataDistribution virtual void delref() { ReferenceCounted::delref(); } private: - // Calculate an "average" of the metrics replies that we received. Penalize teams from which we did not receieve all replies. + // Calculate an "average" of the metrics replies that we received. Penalize teams from which we did not receive all replies. int64_t getLoadAverage() { int64_t bytesSum = 0; int added = 0; diff --git a/fdbserver/sqlite/sqlite3.amalgamation.c b/fdbserver/sqlite/sqlite3.amalgamation.c index de4b00b4a91..7f1376151e7 100644 --- a/fdbserver/sqlite/sqlite3.amalgamation.c +++ b/fdbserver/sqlite/sqlite3.amalgamation.c @@ -167,7 +167,7 @@ ** level of recursion for each term. A stack overflow can result ** if the number of terms is too large. In practice, most SQL ** never has more than 3 or 4 terms. Use a value of 0 to disable -** any limit on the number of terms in a compount SELECT. +** any limit on the number of terms in a compound SELECT. */ #ifndef SQLITE_MAX_COMPOUND_SELECT # define SQLITE_MAX_COMPOUND_SELECT 500 @@ -18242,7 +18242,7 @@ static int unixLock(sqlite3_file *id, int eFileLock){ /* Make sure the locking sequence is correct. ** (1) We never move from unlocked to anything higher than shared lock. - ** (2) SQLite never explicitly requests a pendig lock. + ** (2) SQLite never explicitly requests a pending lock. ** (3) A shared lock is always held when a reserve lock is requested. */ assert( pFile->eFileLock!=NO_LOCK || eFileLock==SHARED_LOCK ); @@ -19491,7 +19491,7 @@ static int afpLock(sqlite3_file *id, int eFileLock){ /* Make sure the locking sequence is correct ** (1) We never move from unlocked to anything higher than shared lock. - ** (2) SQLite never explicitly requests a pendig lock. + ** (2) SQLite never explicitly requests a pending lock. ** (3) A shared lock is always held when a reserve lock is requested. */ assert( pFile->eFileLock!=NO_LOCK || eFileLock==SHARED_LOCK ); @@ -22475,7 +22475,7 @@ static int unixGetLastError(sqlite3_vfs *NotUsed, int NotUsed2, char *NotUsed3){ ** setting the environment variable SQLITE_FORCE_PROXY_LOCKING to 1 will ** force proxy locking to be used for every database file opened, and 0 ** will force automatic proxy locking to be disabled for all database -** files (explicity calling the SQLITE_SET_LOCKPROXYFILE pragma or +** files (explicitly calling the SQLITE_SET_LOCKPROXYFILE pragma or ** sqlite_file_control API is not affected by SQLITE_FORCE_PROXY_LOCKING). */ @@ -67194,7 +67194,7 @@ static void zeroblobFunc( /* ** The replace() function. Three arguments are all strings: call ** them A, B, and C. The result is also a string which is derived -** from A by replacing every occurance of B with C. The match +** from A by replacing every occurrence of B with C. The match ** must be exact. Collating sequences are not used. */ static void replaceFunc( @@ -90931,7 +90931,7 @@ SQLITE_PRIVATE int sqlite3KeywordCode(const unsigned char *z, int n){ ** end result. ** ** Ticket #1066. the SQL standard does not allow '$' in the -** middle of identfiers. But many SQL implementations do. +** middle of identifiers. But many SQL implementations do. ** SQLite will allow '$' in identifiers for compatibility. ** But the feature is undocumented. */ diff --git a/flow/TDMetric.actor.h b/flow/TDMetric.actor.h index 5421b83b5a4..306352c39cf 100755 --- a/flow/TDMetric.actor.h +++ b/flow/TDMetric.actor.h @@ -355,7 +355,7 @@ template <> inline void FieldHeader>::update(Standalone struct FieldValueBlockEncoding { FieldValueBlockEncoding() : prev(0) {} @@ -1156,7 +1156,7 @@ struct FieldValueBlockEncoding> { FieldValueBlockEncoding value_encoding; }; -// ValueBlock encoder/decoder specialization for continous bool metrics because they are encoded +// ValueBlock encoder/decoder specialization for continuous bool metrics because they are encoded // more efficiently than encoding the time and bool types separately. // Instead, time and value are combined to a single value (time delta << 1) + (value ? 1 : 0) and then // that value is encoded as a delta. diff --git a/flow/stacktrace.amalgamation.cpp b/flow/stacktrace.amalgamation.cpp index be9685273c5..b432a808c1a 100644 --- a/flow/stacktrace.amalgamation.cpp +++ b/flow/stacktrace.amalgamation.cpp @@ -1191,7 +1191,7 @@ int GetCPU(); // family of functions as standardized in POSIX.1-2001. // // Note: While Apple provides for both iOS and macOS, it is -// explicity deprecated and will cause build failures if enabled for those +// explicitly deprecated and will cause build failures if enabled for those // platforms. We side-step the issue by not defining it here for Apple // platforms. #ifdef ABSL_HAVE_SEMAPHORE_H @@ -1250,7 +1250,7 @@ int GetCPU(); // ABSL_HAVE_STD_ANY // -// Checks whether C++17 std::any is availble by checking whether exists. +// Checks whether C++17 std::any is available by checking whether exists. #ifdef ABSL_HAVE_STD_ANY #error "ABSL_HAVE_STD_ANY cannot be directly set." #endif From a52e8b8f3ca03a500edda48db945a5177a86a178 Mon Sep 17 00:00:00 2001 From: Vince Polsinelli Date: Thu, 19 Apr 2018 14:12:27 -0400 Subject: [PATCH 002/225] Fixed broken links to documentation --- bindings/go/README.md | 4 ++-- bindings/go/src/fdb/directory/directory.go | 2 +- bindings/go/src/fdb/errors.go | 2 +- bindings/go/src/fdb/keyselector.go | 2 +- bindings/go/src/fdb/subspace/subspace.go | 2 +- bindings/go/src/fdb/transaction.go | 12 ++++++------ bindings/go/src/fdb/tuple/tuple.go | 2 +- bindings/python/README.rst | 2 +- bindings/python/fdb/__init__.py | 2 +- bindings/python/fdb/locality.py | 2 +- bindings/ruby/fdb.gemspec.in | 2 +- bindings/ruby/lib/fdb.rb | 2 +- bindings/ruby/lib/fdbdirectory.rb | 2 +- bindings/ruby/lib/fdbimpl.rb | 2 +- bindings/ruby/lib/fdblocality.rb | 2 +- bindings/ruby/lib/fdbsubspace.rb | 2 +- bindings/ruby/lib/fdbtuple.rb | 2 +- fdbclient/vexillographer/ruby.cs | 2 +- packaging/foundationdb.conf | 2 +- packaging/msi/FDBInstaller.wxs | 2 +- packaging/msi/skeleton.conf | 2 +- packaging/osx/foundationdb.conf.new | 2 +- 22 files changed, 28 insertions(+), 28 deletions(-) diff --git a/bindings/go/README.md b/bindings/go/README.md index 15beef47ed5..d2ae6947bba 100644 --- a/bindings/go/README.md +++ b/bindings/go/README.md @@ -1,7 +1,7 @@ fdb-go ====== -[Go language](http://golang.org) bindings for [FoundationDB](https://www.foundationdb.org/documentation/), a distributed key-value store with ACID transactions. +[Go language](http://golang.org) bindings for [FoundationDB](https://apple.github.io/foundationdb/index.html#documentation), a distributed key-value store with ACID transactions. This package requires: @@ -28,4 +28,4 @@ Documentation ------------- * [API documentation](https://godoc.org/github.com/apple/foundationdb/bindings/go/src/fdb) -* [Tutorial](https://www.foundationdb.org/documentation/class-scheduling-go.html) +* [Tutorial](https://apple.github.io/foundationdb/class-scheduling.html) diff --git a/bindings/go/src/fdb/directory/directory.go b/bindings/go/src/fdb/directory/directory.go index 21f576d1fd3..792621b3860 100644 --- a/bindings/go/src/fdb/directory/directory.go +++ b/bindings/go/src/fdb/directory/directory.go @@ -26,7 +26,7 @@ // // For general guidance on directory usage, see the Directories section of the // Developer Guide -// (https://www.foundationdb.org/documentation/developer-guide.html#developer-guide-directories). +// (https://apple.github.io/foundationdb/developer-guide.html#directories). // // Directories are identified by hierarchical paths analogous to the paths in a // Unix-like file system. A path is represented as a slice of strings. Each diff --git a/bindings/go/src/fdb/errors.go b/bindings/go/src/fdb/errors.go index 7317799fae9..cd551c39fe7 100644 --- a/bindings/go/src/fdb/errors.go +++ b/bindings/go/src/fdb/errors.go @@ -37,7 +37,7 @@ import ( // as a panic from any FoundationDB API function whose name ends with OrPanic. // // You may compare the Code field of an Error against the list of FoundationDB -// error codes at https://www.foundationdb.org/documentation/api-error-codes.html, +// error codes at https://apple.github.io/foundationdb/api-error-codes.html, // but generally an Error should be passed to (Transaction).OnError. When using // (Database).Transact, non-fatal errors will be retried automatically. type Error struct { diff --git a/bindings/go/src/fdb/keyselector.go b/bindings/go/src/fdb/keyselector.go index 538a626a1cb..7d4f45ffe5c 100644 --- a/bindings/go/src/fdb/keyselector.go +++ b/bindings/go/src/fdb/keyselector.go @@ -34,7 +34,7 @@ type Selectable interface { // // The most common key selectors are constructed with the functions documented // below. For details of how KeySelectors are specified and resolved, see -// https://www.foundationdb.org/documentation/developer-guide.html#key-selectors. +// https://apple.github.io/foundationdb/developer-guide.html#key-selectors. type KeySelector struct { Key KeyConvertible OrEqual bool diff --git a/bindings/go/src/fdb/subspace/subspace.go b/bindings/go/src/fdb/subspace/subspace.go index f2523a81ef6..b779d5a9f77 100644 --- a/bindings/go/src/fdb/subspace/subspace.go +++ b/bindings/go/src/fdb/subspace/subspace.go @@ -29,7 +29,7 @@ // As a best practice, API clients should use at least one subspace for // application data. For general guidance on subspace usage, see the Subspaces // section of the Developer Guide -// (https://www.foundationdb.org/documentation/developer-guide.html#developer-guide-sub-keyspaces). +// (https://apple.github.io/foundationdb/developer-guide.html#subspaces). package subspace import ( diff --git a/bindings/go/src/fdb/transaction.go b/bindings/go/src/fdb/transaction.go index 87ff29ae8b4..4ba435ce30d 100644 --- a/bindings/go/src/fdb/transaction.go +++ b/bindings/go/src/fdb/transaction.go @@ -171,7 +171,7 @@ func (t Transaction) SetReadVersion(version int64) { // but making it harder to reason about concurrency. // // For more information on snapshot reads, see -// https://www.foundationdb.org/documentation/developer-guide.html#using-snapshot-reads. +// https://apple.github.io/foundationdb/developer-guide.html#snapshot-reads. func (t Transaction) Snapshot() Snapshot { return Snapshot{t.transaction} } @@ -196,7 +196,7 @@ func (t Transaction) OnError(e Error) FutureNil { // As with other client/server databases, in some failure scenarios a client may // be unable to determine whether a transaction succeeded. For more information, // see -// https://www.foundationdb.org/documentation/developer-guide.html#developer-guide-unknown-results. +// https://apple.github.io/foundationdb/developer-guide.html#transactions-with-unknown-results. func (t Transaction) Commit() FutureNil { return &futureNil{newFuture(C.fdb_transaction_commit(t.ptr))} } @@ -396,7 +396,7 @@ func addConflictRange(t *transaction, er ExactRange, crtype conflictRangeType) e // conflict. // // For more information on conflict ranges, see -// https://www.foundationdb.org/documentation/developer-guide.html#conflict-ranges. +// https://apple.github.io/foundationdb/developer-guide.html#conflict-ranges. func (t Transaction) AddReadConflictRange(er ExactRange) error { return addConflictRange(t.transaction, er, conflictRangeTypeRead) } @@ -413,7 +413,7 @@ func copyAndAppend(orig []byte, b byte) []byte { // this key could cause the transaction to fail with a conflict. // // For more information on conflict ranges, see -// https://www.foundationdb.org/documentation/developer-guide.html#conflict-ranges. +// https://apple.github.io/foundationdb/developer-guide.html#conflict-ranges. func (t Transaction) AddReadConflictKey(key KeyConvertible) error { return addConflictRange(t.transaction, KeyRange{key, Key(copyAndAppend(key.FDBKey(), 0x00))}, conflictRangeTypeRead) } @@ -424,7 +424,7 @@ func (t Transaction) AddReadConflictKey(key KeyConvertible) error { // conflict. // // For more information on conflict ranges, see -// https://www.foundationdb.org/documentation/developer-guide.html#conflict-ranges. +// https://apple.github.io/foundationdb/developer-guide.html#conflict-ranges. func (t Transaction) AddWriteConflictRange(er ExactRange) error { return addConflictRange(t.transaction, er, conflictRangeTypeWrite) } @@ -434,7 +434,7 @@ func (t Transaction) AddWriteConflictRange(er ExactRange) error { // read this key could fail with a conflict. // // For more information on conflict ranges, see -// https://www.foundationdb.org/documentation/developer-guide.html#conflict-ranges. +// https://apple.github.io/foundationdb/developer-guide.html#conflict-ranges. func (t Transaction) AddWriteConflictKey(key KeyConvertible) error { return addConflictRange(t.transaction, KeyRange{key, Key(copyAndAppend(key.FDBKey(), 0x00))}, conflictRangeTypeWrite) } diff --git a/bindings/go/src/fdb/tuple/tuple.go b/bindings/go/src/fdb/tuple/tuple.go index d00a594abf2..bf9365b711e 100644 --- a/bindings/go/src/fdb/tuple/tuple.go +++ b/bindings/go/src/fdb/tuple/tuple.go @@ -27,7 +27,7 @@ // of higher-level data models. // // For general guidance on tuple usage, see the Tuple section of Data Modeling -// (https://www.foundationdb.org/documentation/data-modeling.html#data-modeling-tuples). +// (https://apple.github.io/foundationdb/data-modeling.html#tuples). // // FoundationDB tuples can currently encode byte and unicode strings, integers // and NULL values. In Go these are represented as []byte, string, int64 and diff --git a/bindings/python/README.rst b/bindings/python/README.rst index 168b522f080..2cd7d6f75cb 100644 --- a/bindings/python/README.rst +++ b/bindings/python/README.rst @@ -1,3 +1,3 @@ -Complete documentation of the FoundationDB Python API can be found at https://www.foundationdb.org/documentation/api-python.html. +Complete documentation of the FoundationDB Python API can be found at https://apple.github.io/foundationdb/api-python.html. These bindings require the FoundationDB client. The client can be obtained from https://www.foundationdb.org/downloads/fdb-c/. diff --git a/bindings/python/fdb/__init__.py b/bindings/python/fdb/__init__.py index 34f2419f8e3..2bf616202e7 100644 --- a/bindings/python/fdb/__init__.py +++ b/bindings/python/fdb/__init__.py @@ -21,7 +21,7 @@ # FoundationDB Python API """Documentation for this API can be found at -https://www.foundationdb.org/documentation/api-python.html""" +https://apple.github.io/foundationdb/api-python.html""" def open(*args, **kwargs): diff --git a/bindings/python/fdb/locality.py b/bindings/python/fdb/locality.py index cc298c00c87..d6f6e152010 100644 --- a/bindings/python/fdb/locality.py +++ b/bindings/python/fdb/locality.py @@ -21,7 +21,7 @@ # FoundationDB Python API """Documentation for this API can be found at -https://www.foundationdb.org/documentation/api-python.html""" +https://apple.github.io/foundationdb/api-python.html""" from fdb import impl as _impl diff --git a/bindings/ruby/fdb.gemspec.in b/bindings/ruby/fdb.gemspec.in index ad3cfbbeab1..21c216240df 100644 --- a/bindings/ruby/fdb.gemspec.in +++ b/bindings/ruby/fdb.gemspec.in @@ -9,7 +9,7 @@ Gem::Specification.new do |s| Ruby bindings for the FoundationDB database. Complete documentation of the FoundationDB Ruby API can be found at: -https://www.foundationdb.org/documentation/api-ruby.html. +https://apple.github.io/foundationdb/api-ruby.html. EOF s.authors = ["FoundationDB"] s.email = 'fdb-dist@apple.com' diff --git a/bindings/ruby/lib/fdb.rb b/bindings/ruby/lib/fdb.rb index 0c2e5b5954f..1552641d38b 100644 --- a/bindings/ruby/lib/fdb.rb +++ b/bindings/ruby/lib/fdb.rb @@ -21,7 +21,7 @@ # FoundationDB Ruby API # Documentation for this API can be found at -# https://www.foundationdb.org/documentation/api-ruby.html +# https://apple.github.io/foundationdb/api-ruby.html module FDB @@chosen_version = -1 diff --git a/bindings/ruby/lib/fdbdirectory.rb b/bindings/ruby/lib/fdbdirectory.rb index 5c411fe91e3..d14af34722b 100644 --- a/bindings/ruby/lib/fdbdirectory.rb +++ b/bindings/ruby/lib/fdbdirectory.rb @@ -23,7 +23,7 @@ # FoundationDB Ruby API # Documentation for this API can be found at -# https://www.foundationdb.org/documentation/api-ruby.html +# https://apple.github.io/foundationdb/api-ruby.html require 'thread' diff --git a/bindings/ruby/lib/fdbimpl.rb b/bindings/ruby/lib/fdbimpl.rb index dcee3236b98..565bc915b9a 100644 --- a/bindings/ruby/lib/fdbimpl.rb +++ b/bindings/ruby/lib/fdbimpl.rb @@ -23,7 +23,7 @@ # FoundationDB Ruby API # Documentation for this API can be found at -# https://www.foundationdb.org/documentation/api-ruby.html +# https://apple.github.io/foundationdb/api-ruby.html require 'ffi' diff --git a/bindings/ruby/lib/fdblocality.rb b/bindings/ruby/lib/fdblocality.rb index b661bfd0715..400769adbb3 100644 --- a/bindings/ruby/lib/fdblocality.rb +++ b/bindings/ruby/lib/fdblocality.rb @@ -23,7 +23,7 @@ # FoundationDB Ruby API # Documentation for this API can be found at -# https://www.foundationdb.org/documentation/api-ruby.html +# https://apple.github.io/foundationdb/api-ruby.html module FDB module Locality diff --git a/bindings/ruby/lib/fdbsubspace.rb b/bindings/ruby/lib/fdbsubspace.rb index 3ff7444877d..eab191330a9 100644 --- a/bindings/ruby/lib/fdbsubspace.rb +++ b/bindings/ruby/lib/fdbsubspace.rb @@ -23,7 +23,7 @@ # FoundationDB Ruby API # Documentation for this API can be found at -# https://www.foundationdb.org/documentation/api-ruby.html +# https://apple.github.io/foundationdb/api-ruby.html require_relative 'fdbtuple' diff --git a/bindings/ruby/lib/fdbtuple.rb b/bindings/ruby/lib/fdbtuple.rb index 816d28e1fc2..71b2402693a 100644 --- a/bindings/ruby/lib/fdbtuple.rb +++ b/bindings/ruby/lib/fdbtuple.rb @@ -23,7 +23,7 @@ # FoundationDB Ruby API # Documentation for this API can be found at -# https://www.foundationdb.org/documentation/api-ruby.html +# https://apple.github.io/foundationdb/api-ruby.html module FDB module Tuple diff --git a/fdbclient/vexillographer/ruby.cs b/fdbclient/vexillographer/ruby.cs index c1a0cc9004a..409afb1834b 100644 --- a/fdbclient/vexillographer/ruby.cs +++ b/fdbclient/vexillographer/ruby.cs @@ -79,7 +79,7 @@ public void writeFiles(string filePath, IEnumerable