arangodb · Simran-B · Mar 6, 2023 · Feb 15, 2023 · Oct 28, 2022 · Feb 15, 2023
diff --git a/.githooks/README.md b/.githooks/README.md
@@ -1,11 +1,11 @@
 # Using commit hooks
 
 We automatically check the C++ code that is pushed to our repository for correct 
-formatting. There is a Github action running for all pushes that runs a code
+formatting. There is a GitHub Action running for all pushes that runs a code
 formatting check that is based on clang-format.
 This check will flag non-correctly formatted code as broken.
 
-To make sure only correctly formatted code is pushed to Github, it is recommended
+To make sure only correctly formatted code is pushed to GitHub, it is recommended
 to install a Git pre-commit hook that checks every local commit for correct code
 formatting.
 

diff --git a/CHANGELOG b/CHANGELOG
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -557,7 +557,7 @@ if (CMAKE_COMPILER_IS_CLANG AND NOT MSVC) # exclude clang-cl
 endif ()
 
 # need c++20
-# XXX this should really be set on a per target level using cmake compile_features capabilties
+# XXX this should really be set on a per target level using cmake compile_features capabilities
 set(CMAKE_CXX_STANDARD 20)
 # turn off compiler language extensions (e.g. don't use -std=gnu++20, but
 # -std=c++20).
@@ -783,7 +783,7 @@ if (NOT WINDOWS)
 endif ()
 
 # ------------------------------------------------------------------------------
-# IMPLICIT INCLUDES AND LIBIRARY DIRECTORIES
+# IMPLICIT INCLUDES AND LIBRARY DIRECTORIES
 # ------------------------------------------------------------------------------
 
 function(CREATE_FLAGS OUTPUT GLUE)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -72,7 +72,7 @@ in the ArangoDB source tree:
 
 ### Style Guide
 
-We use `clang-format` to enfore consistent code formatting. Check 
+We use `clang-format` to enforce consistent code formatting. Check 
 [STYLEGUIDE.md](STYLEGUIDE.md) for a comprehensive description of ArangoDB's 
 Coding Guidelines.
 
@@ -237,7 +237,7 @@ Note: Make sure that your source path does not contain spaces otherwise the buil
 ArangoDB uses a build system called [Oskar](https://github.com/arangodb/oskar).
 Please refer to the documentation of Oskar for details.
 
-Optimizations and limit of architecture (list of possible CPU instuctions) are set using this `cmake` option
+Optimizations and limit of architecture (list of possible CPU instructions) are set using this `cmake` option
 in addition to the other options:
 
 ```
@@ -287,7 +287,7 @@ favorite browser and open the web interface.
 All changes to any source will automatically re-build and reload your browser.
 Enjoy :)
 
-### Cross Orogin Policy (CORS) ERROR
+### Cross Origin Policy (CORS) ERROR
 
 Our front-end development server currently runs on port:`3000`, while the backend runs on port:`8529` respectively. This implies that when the front-end sends a request to the backend would result in Cross-Origin-Policy security checks which recently got enforced by some browsers for security reasons. Until recently, we never had reports of CORS errors when running both the backend and front-end dev servers independently, however,
 we recently confirmed that this error occurs in ( Chrome v: 98.0.4758.102 and Firefox v: 96.0.1 ).
@@ -411,7 +411,7 @@ You now will get log entries with the contents being passed between the blocks.
 
 ### Crashes
 
-The Linux builds of the arangod execuable contain a built-in crash handler
+The Linux builds of the arangod executable contain a built-in crash handler
 (introduced in v3.7.0).
 The crash handler is supposed to log basic crash information to the ArangoDB logfile in
 case the arangod process receives one of the signals SIGSEGV, SIGBUS, SIGILL, SIGFPE or
@@ -421,7 +421,7 @@ SIGABRT. SIGKILL signals, which the operating system can send to a process in ca
 In case the crash handler receives one of the mentioned interceptable signals, it will
 write basic crash information to the logfile and a backtrace of the call site.
 The backtrace can be provided to the ArangoDB support for further inspection. Note that
-backtaces are only usable if debug symbols for ArangoDB have been installed as well.
+backtraces are only usable if debug symbols for ArangoDB have been installed as well.
 
 After logging the crash information, the crash handler will execute the default action for
 the signal it has caught. If core dumps are enabled, the default action for these signals
@@ -783,8 +783,8 @@ There are several major places where unittests live:
 | `js/client/modules/@arangodb/testutils/test-utils.js`        | infrastructure for tests like filtering, bucketing, iterating                                                                      |
 | `js/client/modules/@arangodb/testutils/process-utils.js`     | manage arango instances, start/stop/monitor SUT-processes                                                                          |
 | `js/client/modules/@arangodb/testutils/result-processing.js` | work with the result structures to produce reports, hit lists etc.                                                                 |
-| `js/client/modules/@arangodb/testutils/crash-utils.js`       | if somethings goes wrong, this contains the crash analysis tools                                                                   |
-| `js/client/modules/@arangodb/testutils/clusterstats.js`      | can be launched seperately to monitor the cluster instances and their resource usage                                               |
+| `js/client/modules/@arangodb/testutils/crash-utils.js`       | if something goes wrong, this contains the crash analysis tools                                                                   |
+| `js/client/modules/@arangodb/testutils/clusterstats.js`      | can be launched separately to monitor the cluster instances and their resource usage                                               |
 | `js/client/modules/@arangodb/testsuites/`                    | modules with testframework that control one set of tests each                                                                      |
 | `js/common/modules[/jsunity]/jsunity.js`                     | jsunity testing framework; invoked via jsunity.js next to the module                                                               |
 | `js/common/modules/@arangodb/mocha-runner.js`                | wrapper for running mocha tests in arangodb                                                                                        |
@@ -1030,7 +1030,7 @@ The `rta_makedata` testsuite can be invoked with:
 
 - `--cluster false` - to be ran on a single server setup.
 - `--activefailover true` to be ran on an active failover setup.
-- `--cluster true` to be ran on a 3 db-server node cluster; one run will check resillience with 2 remaining dbservers.
+- `--cluster true` to be ran on a 3 db-server node cluster; one run will check resilience with 2 remaining dbservers.
 
 Invoke it like this:
 
@@ -1053,7 +1053,7 @@ Once this is completed, you may run it like this:
     ./scripts/unittest go_driver --gosource ../go-driver/ --testCase View --goOptions:timeout 180m --cluster true
 
 This will invoke the test with a filter to only execute tests that have `View` in their name.
-As an aditional parameter we pass `-timeout 100m` to the driver test.
+As an additional parameter we pass `-timeout 100m` to the driver test.
 
 The driver integration also features JWT pass in. It will launch a cluster with 3 DB-Servers, as
 the tests expect to have at least 3 DB-Servers.
@@ -1110,7 +1110,7 @@ At the time being phpunit version 6.5 is supported. Install it like this:
 
 Once this is completed, you may run it like this:
 
-    ./scipts/unittest php_driver --phpsource ../arangodb-php/ \
+    ./scripts/unittest php_driver --phpsource ../arangodb-php/ \
         --testCase testSaveVerticesAndEdgeBetweenThemAndRemoveOneByOne \
         --cluster true \
         --phpkeepalive false
@@ -1133,7 +1133,7 @@ All required data is passed as parameters:
 - driverOptions options to be passed on to the driver works in the form of
   `--driverOptions.argname value` evaluating to `--argname` `value`
 - `--test testcase` evaluates to `--testsuite testcase`
-- `--testCase testcaseExp` evalates to `--filter testcaseExp`
+- `--testCase testcaseExp` evaluates to `--filter testcaseExp`
 
 Statically provided options (with sample values):
 
@@ -1210,7 +1210,7 @@ Choose the `Npcap Loopback Adapter` number - 1:
       --sniff true \
       --cleanup false \
       --sniffDevice 1 \
-      --sniffProgram 'c:/Programm Files/wireshark/tshark.exe' \
+      --sniffProgram 'c:/Program Files/wireshark/tshark.exe' \
       --forceJson true
 
 You can later on use Wireshark to inspect the capture files.
@@ -1232,7 +1232,7 @@ Currently available Analyzers are:
 - unitTestTabularPrintResults - prints a table, add one (or more) of the following columns to print by adding it to `--tableColumns`:
 
   - `duration` - the time spent in the complete testfile
-  - `status` - sucess/fail
+  - `status` - success/fail
   - `failed` - fail?
   - `total` - the time spent in the testcase
   - `totalSetUp` - the time spent in setup summarized

@@ -53,7 +53,7 @@ the server error number
 a descriptive error message
 
 @RESTRETURNCODE{404}
-If the specified user user function does not exist, the server will respond with *HTTP 404*.
+If the specified user function does not exist, the server will respond with *HTTP 404*.
 
 @RESTREPLYBODY{error,boolean,required,}
 boolean flag to indicate whether an error occurred (*true* in this case)

@@ -1,6 +1,6 @@
 
 @startDocuBlock get_api_aqlfunction
-@brief gets all reqistered AQL user functions
+@brief gets all registered AQL user functions
 
 @RESTHEADER{GET /_api/aqlfunction, Return registered AQL user functions, RestAqlUserFunctionsHandler:List}
 

@@ -35,7 +35,7 @@ A plain text message stating what went wrong.
 
 @EXAMPLES
 
-trying to delete non existing task
+Try to delete a non-existent task:
 
 @EXAMPLE_ARANGOSH_RUN{RestTasksDeleteFail}
     var url = "/_api/tasks/NoTaskWithThatName";
@@ -47,7 +47,7 @@ trying to delete non existing task
     logJsonResponse(response);
 @END_EXAMPLE_ARANGOSH_RUN
 
-Remove existing Task
+Remove existing task:
 
 @EXAMPLE_ARANGOSH_RUN{RestTasksDelete}
     var url = "/_api/tasks/";

@@ -182,7 +182,7 @@ the number of intermediate commits done
 Statistics about the V8 javascript contexts
 
 @RESTSTRUCT{available,v8_context_struct,integer,required,}
-the number of currently spawnen V8 contexts
+the number of currently spawned V8 contexts
 
 @RESTSTRUCT{busy,v8_context_struct,integer,required,}
 the number of currently active V8 contexts
@@ -228,7 +228,7 @@ The number of spawned worker threads
 The number of currently busy worker threads
 
 @RESTSTRUCT{queued,server_threads_struct,integer,required,}
-The number of jobs queued up waiting for worker threads becomming available
+The number of jobs queued up waiting for worker threads becoming available
 
 @EXAMPLES
 

@@ -74,7 +74,7 @@ currently only *little* is supported
 which method do we use to handle fd-sets, *poll* should be here on linux.
 
 @RESTSTRUCT{fd-setsize,version_details_struct,string,optional,}
-if not *poll* the fd setsize is valid for the maximum number of filedescriptors
+if not *poll* the fd setsize is valid for the maximum number of file descriptors
 
 @RESTSTRUCT{full-version-string,version_details_struct,string,optional,}
 The full version string
@@ -125,7 +125,7 @@ the version of the used velocypack implementation
 the version of the bundled zlib
 
 @RESTSTRUCT{mode,version_details_struct,string,optional,}
-the mode we're runnig as - one of [*server*, *console*, *script*]
+the mode we're running as - one of [*server*, *console*, *script*]
 
 @RESTSTRUCT{host,version_details_struct,string,optional,}
 the host ID

@@ -76,6 +76,6 @@ within the timeout, then an *HTTP 408* is returned.
     };
 @END_EXAMPLE_ARANGOSH_RUN
 
-The result `body` contains besides the above discussed error codes the `result` object, if `code` is equal to `201`, which holds the unique identifier of this hot backup as the string attibute `id`, the full size in bytes as `sizeInBytes`, the number of idividual files as `nrFiles` and the number of database servers as `nrDBServers`. Single server deployments list potentially misleadingly `nrDBServers: 1`. Furthermore, the body contains a `datetime` time stamp and the flag `potentiallyInconsistent`, which indicates that the backup could inconsistent. This only happens if `allowInconsistent` has happened.
+The result `body` contains besides the above discussed error codes the `result` object, if `code` is equal to `201`, which holds the unique identifier of this hot backup as the string attribute `id`, the full size in bytes as `sizeInBytes`, the number of individual files as `nrFiles` and the number of database servers as `nrDBServers`. Single server deployments list potentially misleadingly `nrDBServers: 1`. Furthermore, the body contains a `datetime` time stamp and the flag `potentiallyInconsistent`, which indicates that the backup could inconsistent. This only happens if `allowInconsistent` has happened.
 
 @endDocuBlock
@@ -52,7 +52,7 @@ If the download command is invoked with bad parameters or any HTTP
 method other than `POST`, then an *HTTP 400* is returned.
 
 @RESTRETURNCODE{401}
-If the authentication to the rempote repository fails, then an *HTTP
+If the authentication to the remote repository fails, then an *HTTP
 401* is returned.
 
 @RESTRETURNCODE{404}

@@ -48,11 +48,11 @@ operation is aborted.
 If all is well, code 202 is returned if a new operation is scheduled.
 
 @RESTRETURNCODE{400}
-If the upload command is invoced with bad parameters or any HTTP
+If the upload command is invoked with bad parameters or any HTTP
 method other than `POST`, then an *HTTP 400* is returned.
 
 @RESTRETURNCODE{401}
-If the authentication to the rempote repository fails, then an *HTTP
+If the authentication to the remote repository fails, then an *HTTP
 400* is returned.
 
 @RESTRETURNCODE{404}

@@ -39,7 +39,7 @@ The response sent by the server is a multipart response, too. It contains
 the individual HTTP responses for all batch parts, including the full HTTP
 result header (with status code and other potential headers) and an
 optional result body. The individual batch parts in the result are
-seperated using the same boundary value as specified in the request.
+separated using the same boundary value as specified in the request.
 
 The order of batch parts in the response will be the same as in the
 original client request. Client can additionally use the `Content-Id`
@@ -121,9 +121,9 @@ in this case try to find the boundary at the beginning of the request body).
 @EXAMPLE_ARANGOSH_RUN{RestBatchImplicitBoundary}
     var parts = [
       "Content-Type: application/x-arango-batchpart\r\n\r\n" +
-         "DELETE /_api/collection/notexisting1 HTTP/1.1\r\n",
+         "DELETE /_api/collection/nonexistent1 HTTP/1.1\r\n",
       "Content-Type: application/x-arango-batchpart\r\n\r\n" +
-         "DELETE _api/collection/notexisting2 HTTP/1.1\r\n"
+         "DELETE _api/collection/nonexistent2 HTTP/1.1\r\n"
     ];
     var boundary = "SomeBoundaryValue";
     var body = "--" + boundary + "\r\n" +

@@ -56,7 +56,7 @@ violation. Possible values are:
 - `ignore`: this will not update an existing document and simply ignore the
   error caused by a unique key constraint violation.
 
-Note that that `update`, `replace` and `ignore` will only work when the
+Note that `update`, `replace` and `ignore` will only work when the
 import document in the request contains the `_key` attribute. `update` and
 `replace` may also fail because of secondary unique key constraint violations.
 

@@ -75,7 +75,7 @@ for a SatelliteCollection (Enterprise Edition only). _(cluster only)_
 
 @RESTSTRUCT{writeConcern,collection_info,integer,optional,}
 Determines how many copies of each shard are required to be
-in sync on the different DB-Servers. If there are less then these many copies
+in sync on the different DB-Servers. If there are less than these many copies
 in the cluster a shard will refuse to write. Writes to shards with enough
 up-to-date copies will succeed at the same time however. The value of
 `writeConcern` cannot be larger than `replicationFactor`. _(cluster only)_

@@ -24,7 +24,7 @@ and their format is subject to change. By default, `details` is set to `false`,
 so no details are returned and the behavior is identical to previous versions
 of ArangoDB.
 Please note that requesting `details` may cause additional load and thus have
-an impact on performace.
+an impact on performance.
 
 @RESTDESCRIPTION
 In addition to the above, the result also contains the number of documents

@@ -161,7 +161,7 @@ copies take over, usually without an error being reported.
 @RESTBODYPARAM{writeConcern,integer,optional,int64}
 Write concern for this collection (default: 1).
 It determines how many copies of each shard are required to be
-in sync on the different DB-Servers. If there are less then these many copies
+in sync on the different DB-Servers. If there are less than these many copies
 in the cluster a shard will refuse to write. Writes to shards with enough
 up-to-date copies will succeed at the same time however. The value of
 `writeConcern` cannot be larger than `replicationFactor`. _(cluster only)_

@@ -86,7 +86,7 @@ copies take over, usually without an error being reported.
 @RESTBODYPARAM{writeConcern,integer,optional,int64}
 Write concern for this collection (default: 1).
 It determines how many copies of each shard are required to be
-in sync on the different DB-Servers. If there are less then these many copies
+in sync on the different DB-Servers. If there are less than these many copies
 in the cluster a shard will refuse to write. Writes to shards with enough
 up-to-date copies will succeed at the same time however. The value of
 *writeConcern* can not be larger than *replicationFactor*. _(cluster only)_

@@ -26,7 +26,7 @@ _(cluster only)_
 @RESTSTRUCT{writeConcern,get_api_database_new_OPTIONS,number,optional,}
 Default write concern for new collections created in this database.
 It determines how many copies of each shard are required to be
-in sync on the different DB-Servers. If there are less then these many copies
+in sync on the different DB-Servers. If there are less than these many copies
 in the cluster a shard will refuse to write. Writes to shards with enough
 up-to-date copies will succeed at the same time however. The value of
 *writeConcern* can not be larger than *replicationFactor*. _(cluster only)_

@@ -71,7 +71,7 @@ The response body contains an error document in this case.
 @RESTRETURNCODE{409}
 is returned if we fail to lock the document key due to some
 concurrent operation that is operating on the same document.
-This also also referred to as a write-write conflict.
+This is also referred to as a write-write conflict.
 The response body contains an error document in this case with the
 errorNum set to 1200 (`ERROR_ARANGO_CONFLICT`).
 

@@ -155,7 +155,7 @@ index. The response body contains an error document in
 this case with the errorNum set to 1210 (`ERROR_ARANGO_UNIQUE_CONSTRAINT_VIOLATED`).
 2) if we fail to lock the document key or some unique index entry
 due to some concurrent operation that is operating on the same
-document. This also also referred to as a write-write conflict.
+document. This is also referred to as a write-write conflict.
 The response body contains an error document in this case with the
 errorNum set to 1200 (`ERROR_ARANGO_CONFLICT`).
 

@@ -150,7 +150,7 @@ unique constraint. The response body contains an error document in
 this case with the errorNum set to 1210 (`ERROR_ARANGO_UNIQUE_CONSTRAINT_VIOLATED`).
 2) if we fail to lock the document key or some unique index entry
 due to some concurrent operation that is operating on the same
-document. This also also referred to as a write-write conflict.
+document. This is also referred to as a write-write conflict.
 The response body contains an error document in this case with the
 errorNum set to 1200 (`ERROR_ARANGO_CONFLICT`).