Skip to content

Commit

Permalink
Add text about build logic to the style guide.
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
davidben authored and agl committed Jul 6, 2017
1 parent a1ce856 commit 00019f2
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

0 comments on commit 00019f2

Please sign in to comment.