diff options
| author | Ryan Egesdahl <ryan.egesdahl@mongodb.com> | 2021-03-01 17:03:48 -0800 |
|---|---|---|
| committer | Evergreen Agent <no-reply@evergreen.mongodb.com> | 2021-03-24 04:14:30 +0000 |
| commit | 6a7d484401c4b773794f181f4621a1959123da72 (patch) | |
| tree | b80645ad339c7e1b2c8b6b7b6439402b45b17fa3 /docs/build_system_reference.md | |
| parent | cde832c0b8e5496ba575d07cef9e4642c19ed521 (diff) | |
| download | mongo-6a7d484401c4b773794f181f4621a1959123da72.tar.gz | |
SERVER-54872 Create build system document outlines
These will be the site of future build system documentation. We will be
adding to it over time.
Diffstat (limited to 'docs/build_system_reference.md')
| -rw-r--r-- | docs/build_system_reference.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/build_system_reference.md b/docs/build_system_reference.md new file mode 100644 index 00000000000..65cfea7bfea --- /dev/null +++ b/docs/build_system_reference.md @@ -0,0 +1,46 @@ +# MongoDB Build System Reference + +## MongoDB Build System Requirements +### Recommended minimum requirements +### Python modules +### External libraries +### Enterprise module requirements +### Testing requirements + +## MongoDB customizations +### SCons modules +### Development tools +#### Compilation database generator +### Build tools +#### IDL Compiler +### Auxiliary tools +#### Ninja generator +#### Icecream tool +#### ccache tool +### LIBDEPS +#### Design +#### Linting and linter tags + +## Build system configuration +### SCons configuration +#### Frequently used flags and variables +### MongoDB build configuration +#### Frequently used flags and variables +### Targets and Aliases + +## Build artifacts and installation +### Hygienic builds +### AutoInstall +### AutoArchive + +## MongoDB SCons style guide +### Sconscript Formatting Guidelines +#### Vertical list style +#### Alphabetize everything +### `Environment` Isolation +### Declaring Targets (`Program`, `Library`, and `CppUnitTest`) +### Invoking external tools correctly with `Command`s +### Customizing an `Environment` for a target +### Invoking subordinate `SConscript`s +#### `Import`s and `Export`s +### A Model `SConscript` with Comments |