xref: /aosp_15_r20/external/boringssl/src/gen/README.md (revision 8fb009dc861624b67b6cdb62ea21f0f22d0c584b)
1*8fb009dcSAndroid Build Coastguard Worker# Pre-generated files
2*8fb009dcSAndroid Build Coastguard Worker
3*8fb009dcSAndroid Build Coastguard WorkerThis directory contains a number of pre-generated build artifacts. To simplify
4*8fb009dcSAndroid Build Coastguard Workerdownstream builds, they are checked into the repository, rather than dynamically
5*8fb009dcSAndroid Build Coastguard Workergenerated as part of the build.
6*8fb009dcSAndroid Build Coastguard Worker
7*8fb009dcSAndroid Build Coastguard WorkerWhen developing on BoringSSL, if any inputs to these files are modified, callers
8*8fb009dcSAndroid Build Coastguard Workermust run the following command to update the generated files:
9*8fb009dcSAndroid Build Coastguard Worker
10*8fb009dcSAndroid Build Coastguard Worker    go run ./util/pregenerate
11*8fb009dcSAndroid Build Coastguard Worker
12*8fb009dcSAndroid Build Coastguard WorkerTo check that files are up-to-date without updating files, run:
13*8fb009dcSAndroid Build Coastguard Worker
14*8fb009dcSAndroid Build Coastguard Worker    go run ./util/pregenerate -check
15*8fb009dcSAndroid Build Coastguard Worker
16*8fb009dcSAndroid Build Coastguard WorkerThis is run on CI to ensure the generated files remain up-to-date.
17*8fb009dcSAndroid Build Coastguard Worker
18*8fb009dcSAndroid Build Coastguard WorkerTo speed up local iteration, the tool accepts additional arguments to filter the
19*8fb009dcSAndroid Build Coastguard Workerfiles generated. For example, if editing `aesni-x86_64.pl`, this
20*8fb009dcSAndroid Build Coastguard Workercommand will only update files with "aesni-x86_64" as a substring.
21*8fb009dcSAndroid Build Coastguard Worker
22*8fb009dcSAndroid Build Coastguard Worker    go run ./util/pregenerate aesni-x86_64
23*8fb009dcSAndroid Build Coastguard Worker
24*8fb009dcSAndroid Build Coastguard WorkerFor convenience, all files in this directory, including this README, are managed
25*8fb009dcSAndroid Build Coastguard Workerby the tool. This means the whole directory may be deleted and regenerated from
26*8fb009dcSAndroid Build Coastguard Workerscratch at any time.
27