diff --git a/.prettierignore b/.prettierignore index 83e658233d1..a6878e58633 100644 --- a/.prettierignore +++ b/.prettierignore @@ -8,8 +8,6 @@ *.json *.wxs -README - # Ignore files that fail after format jstests/noPassthrough/js_exceptions.js jstests/noPassthrough/network/client_metadata_slowlog.js diff --git a/distsrc/README b/distsrc/README index 05be7934f19..70542cbc891 100644 --- a/distsrc/README +++ b/distsrc/README @@ -1,88 +1,87 @@ -MongoDB README - -Welcome to MongoDB! - -COMPONENTS - - mongod - The database server. - mongos - Sharding router. - mongo - The database shell (uses interactive javascript). - -UTILITIES - - install_compass - Installs MongoDB Compass for your platform. - -BUILDING - - See docs/building.md. - -RUNNING - - For command line options invoke: - - $ ./mongod --help - - To run a single server database: - - $ sudo mkdir -p /data/db - $ ./mongod - $ - $ # The mongo javascript shell connects to localhost and test database by default: - $ ./mongo - > help - -INSTALLING COMPASS - - You can install compass using the install_compass script packaged with MongoDB: - - $ ./install_compass - - This will download the appropriate MongoDB Compass package for your platform - and install it. - -DRIVERS - - Client drivers for most programming languages are available at - https://docs.mongodb.com/manual/applications/drivers/. Use the shell - ("mongo") for administrative tasks. - -BUG REPORTS - - See https://github.com/mongodb/mongo/wiki/Submit-Bug-Reports. - -PACKAGING - - Packages are created dynamically by the packager.py script located in the - buildscripts directory. This will generate RPM and Debian packages. - -DOCUMENTATION - - https://docs.mongodb.com/manual/ - -CLOUD HOSTED MONGODB - - https://www.mongodb.com/cloud/atlas - -FORUMS - - https://community.mongodb.com - - A forum for technical questions about using MongoDB. - - https://community.mongodb.com/c/server-dev - - A forum for technical questions about building and developing MongoDB. - -LEARN MONGODB - - https://university.mongodb.com/ - -LICENSE - - MongoDB is free and open-source. Versions released prior to October 16, - 2018 are published under the AGPL. All versions released after October - 16, 2018, including patch fixes for prior versions, are published under - the Server Side Public License (SSPL) v1. See individual files for - details which will specify the license applicable to each file. Files - subject to the SSPL will be noted in their headers. - +MongoDB README + +Welcome to MongoDB! + +COMPONENTS + +mongod - The database server. +mongos - Sharding router. +mongo - The database shell (uses interactive javascript). + +UTILITIES + +install_compass - Installs MongoDB Compass for your platform. + +BUILDING + +See docs/building.md. + +RUNNING + +For command line options invoke: + + $ ./mongod --help + +To run a single server database: + + $ sudo mkdir -p /data/db + $ ./mongod + $ + $ # The mongo javascript shell connects to localhost and test database by default: + $ ./mongo + > help + +INSTALLING COMPASS + +You can install compass using the install_compass script packaged with MongoDB: + + $ ./install_compass + +This will download the appropriate MongoDB Compass package for your platform +and install it. + +DRIVERS + +Client drivers for most programming languages are available at +https://docs.mongodb.com/manual/applications/drivers/. Use the shell +("mongo") for administrative tasks. + +BUG REPORTS + +See https://github.com/mongodb/mongo/wiki/Submit-Bug-Reports. + +PACKAGING + +Packages are created dynamically by the packager.py script located in the +buildscripts directory. This will generate RPM and Debian packages. + +DOCUMENTATION + +https://docs.mongodb.com/manual/ + +CLOUD HOSTED MONGODB + +https://www.mongodb.com/cloud/atlas + +FORUMS + +https://community.mongodb.com + + A forum for technical questions about using MongoDB. + +https://community.mongodb.com/c/server-dev + + A forum for technical questions about building and developing MongoDB. + +LEARN MONGODB + +https://university.mongodb.com/ + +LICENSE + +MongoDB is free and open-source. Versions released prior to October 16, +2018 are published under the AGPL. All versions released after October +16, 2018, including patch fixes for prior versions, are published under +the Server Side Public License (SSPL) v1. See individual files for +details which will specify the license applicable to each file. Files +subject to the SSPL will be noted in their headers. diff --git a/jstests/ssl/x509/README b/jstests/ssl/x509/README index e85e25ecb4f..6904b80436d 100644 --- a/jstests/ssl/x509/README +++ b/jstests/ssl/x509/README @@ -1,8 +1,8 @@ This directory contains two scripts. -mkcert.py - A python3 script using PyOpenSSL to generate the majority of - X509 certificates based on the contents of certs.yml -mkcrl.sh - Certificate Revocation List generators. +mkcert.py - A python3 script using PyOpenSSL to generate the majority of +X509 certificates based on the contents of certs.yml +mkcrl.sh - Certificate Revocation List generators. mkcert.py may be invoked without any arguments, in which case it will regenerate ALL certificates. Alternatively, pass one or more certificate symbolic names. @@ -10,6 +10,7 @@ If any of these certificates represent CAs, then all dependent certificates will cert.yml format: +``` global: output_path: '.../' # Required, default output path for all certs in this file. Subject: {...} # Optional, name entities to use for all cert, overridden by values in cert entries. @@ -35,7 +36,7 @@ certs: serial: 42 # Optional, validity start date, currently expressed in seconds relative to now. not_before: -86400 # 1 day ago - # Optional, validity end date, currently expressed in seconds relative to now. + # Optional, validity end date, currently expressed in seconds relative to now. # Note that not_after - not_before, the validity period, should be less than or equal to 825 days, see: # https://support.apple.com/en-us/HT210176 not_after: 71107200 # 823 days from now @@ -65,3 +66,4 @@ certs: - {role: readWrite, db: test1} - {role: read, db: test2} - mongoClusterMembership: clusterName +``` diff --git a/src/mongo/base/concept/README b/src/mongo/base/concept/README index bc2c74fabe4..d0429162f43 100644 --- a/src/mongo/base/concept/README +++ b/src/mongo/base/concept/README @@ -1,5 +1,5 @@ This directory contains a number of C++ headers which describe concepts for -C++ types used by and with the Mongo library. These headers do not describe +C++ types used by and with the Mongo library. These headers do not describe instantiable types, but instead are used to concisely describe models of C++ -type concepts. When C++ grows a proper `Concepts` feature, these files can be +type concepts. When C++ grows a proper `Concepts` feature, these files can be converted to proper concepts. diff --git a/src/mongo/bson/README b/src/mongo/bson/README index 01ed654bcd2..c143f8063cd 100644 --- a/src/mongo/bson/README +++ b/src/mongo/bson/README @@ -1,7 +1,5 @@ -"BSON" stands for "binary JSON" - a binary storage format that is JSON inspired +"BSON" stands for "binary JSON" - a binary storage format that is JSON inspired (and adds a couple extra types such as Date). -This is the C++ implementation. Implementations which translate BSON<->JSON +This is the C++ implementation. Implementations which translate BSON<->JSON are available for most languages at bsonspec.org. - - diff --git a/x509/README b/x509/README index 80e7e24040d..8d48f665f24 100644 --- a/x509/README +++ b/x509/README @@ -10,11 +10,14 @@ This directory contains: To run: +``` python x509/mkcert.py CONFIG [--mkcrl | --no-mkcrl] [-o OUTPUT] [--static-dir STATIC_DIR] [--dry-run] [certs ...] +``` + - CONFIG is the path to the JSON file specifying a list of certificates, required - OUTPUT is the path to a directory where the generated items will be stored, default . -- STATIC_DIR is the path where signing keys needed by certificates are stored, default x509/static +- STATIC_DIR is the path where signing keys needed by certificates are stored, default x509/static - If --mkcrl is specified, CRLs will be generated after certificate generation ends. Default false. These are hardcoded and require certain certificates to be generated to work. - If --dry-run is specified, no files will be written out. This can be used to test what files will @@ -38,6 +41,7 @@ Future work: Certificate definition format: +``` { "global": { # Optional, default value to use for Key1 for all certs, overridden by values in cert entries. @@ -61,7 +65,7 @@ Certificate definition format: # Optional, serial number to assign this certificate (default: sequential numbers starting from 1000) "serial": 42, # Optional, validity start date, expressed in seconds relative to midnight on the first day of the current year. - "not_before": -86400, # 1 day before + "not_before": -86400, # 1 day before # Optional, validity end date, currently expressed in seconds relative to midnight on the first day of the current year. # Note that not_after - not_before, the validity period, should be less than or equal to 825 days, see: # https://support.apple.com/en-us/HT210176 @@ -103,3 +107,4 @@ Certificate definition format: ... ] } +```