kris/boringssl
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add text about build logic to the style guide.

Browse Source 
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>
This commit is contained in:
David Benjamin 2017-07-01 21:42:06 -04:00 committed by Adam Langley
parent a1ce85696d
commit 00019f2193
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
STYLE.md
View File

@ -207,3 +207,14 @@ return value patterns in legacy functions.
Document private functions in their `internal.h` header or, if static, Document private functions in their `internal.h` header or, if static,
where defined. 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`.