godotengine/godot-angle-static
1
0
Fork 0
mirror of https://github.com/godotengine/godot-angle-static.git synced 2026-01-06 02:09:55 +03:00
Code Issues Packages Projects Releases Wiki Activity

Formalize preference for handling generated code.

Browse Source 
This documents the discussion and conclusion on preferring to bake
generated code into the repository.

Bug: angleproject:3333
Change-Id: I1afc338c59d5bcb2a64f843081aba5120820e9ba
Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/1558676
Reviewed-by: Shahbaz Youssefi <syoussefi@chromium.org>
Reviewed-by: Yuly Novikov <ynovikov@chromium.org>
Commit-Queue: Jamie Madill <jmadill@chromium.org>
This commit is contained in:
Jamie Madill
2019-04-08 16:34:03 -04:00
committed by Commit Bot
parent 0086a8acd8
commit 9f7585bf35
1 changed files with 21 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/CodingStandard.md
View File

@@ -154,3 +154,24 @@ const string &str;
* If modifying pre-existing code that does not match the standard, the altered
portions of the code should be changed to match the standard.
### Generated Source Files
Prefer storing generated sources as baked files in the repository. Avoid using
GN actions to run Python scripts.
**Definition:**
Sometimes helper scripts can create compilable sources more easily from XML or
JSON data sources than maintaining source files by hand. These scripts are often
written in Python and output generated sources.
**Decision**
Storing generated sources in the repository makes integration easier for non-GN
users. Python scripts can be expensive and slow to run at compile-time.
Generated sources can be a pain point for messing up builds.
It could be possible to solve the build clobbering problem. And we could replace
Python with something faster. But to allow for easier integration with our tools
and customers we should bake generated files into the repository.