From 00019f2193680316b0b80f8e1629452f3e00e516 Mon Sep 17 00:00:00 2001 From: David Benjamin Date: Sat, 1 Jul 2017 21:42:06 -0400 Subject: [PATCH] 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 --- STYLE.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/STYLE.md b/STYLE.md index 4b377e71..3c74b45c 100644 --- a/STYLE.md +++ b/STYLE.md @@ -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`.