diff options
| author | David Benjamin <davidben@google.com> | 2017-07-01 21:42:06 -0400 |
|---|---|---|
| committer | Adam Langley <agl@google.com> | 2017-07-06 01:38:28 +0000 |
| commit | 00019f2193680316b0b80f8e1629452f3e00e516 (patch) | |
| tree | 7d5669ed6cbf9fde15f04b5fef857402a4278466 /STYLE.md | |
| parent | a1ce85696d2ba58a5739e0bb05e181717ff1f7db (diff) | |
| download | boringssl-00019f2193680316b0b80f8e1629452f3e00e516.zip boringssl-00019f2193680316b0b80f8e1629452f3e00e516.tar.gz boringssl-00019f2193680316b0b80f8e1629452f3e00e516.tar.bz2 | |
Add text about build logic to the style guide.
This would be unfamiliar to anyone coming from Chromium.
Change-Id: If9fbdbbadfd874c25dc6ff447ab4af36de0dcd22
Reviewed-on: https://boringssl-review.googlesource.com/17544
Reviewed-by: Adam Langley <agl@google.com>
Diffstat (limited to 'STYLE.md')
| -rw-r--r-- | STYLE.md | 11 |
1 files changed, 11 insertions, 0 deletions
@@ -207,3 +207,14 @@ return value patterns in legacy functions. Document private functions in their `internal.h` header or, if static, where defined. + + +## Build logic + +BoringSSL is used by many projects with many different build tools. +Reimplementing and maintaining build logic in each downstream build is +cumbersome, so build logic should be avoided where possible. Platform-specific +files should be excluded by wrapping the contents in `#ifdef`s, rather than +computing platform-specific file lists. Generated source files such as perlasm +and `err_data.c` may be used in the standalone CMake build but, for downstream +builds, they should be pre-generated in `generate_build_files.py`. |