0

Clarify boilerplate.py documentation

I had a nasty surprise when I ran this from a subdirectory :)

Change-Id: If14b37459bae917092fcee1a64c20247005a0d2f
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3221311
Commit-Queue: Tommy Martino <tmartino@chromium.org>
Reviewed-by: Sylvain Defresne <sdefresne@chromium.org>
Cr-Commit-Position: refs/heads/main@{#931505}
This commit is contained in:
Tommy Martino
2021-10-14 15:19:48 +00:00
committed by Chromium LUCI CQ
parent 1d86ce7d8d
commit e8e980fcac

@ -39,8 +39,10 @@ of any kind), the following general steps need to happen:
For adding new header or implementation files, the following procedure is
recommended:
1. Generate the new files using `tools/boilerplate.py`. This will generate the
correct header guard macros and include the copyright boilerplate.
1. Generate the new files using `tools/boilerplate.py`. This will generate
header guard macros and include the copyright boilerplate. Make sure to run
this from root (`src/`) so the header guards include the correct, full
path.
2. Add the newly created files using `git add`.