chromium/src
0
Fork 0
Code Activity

Update how_to_add_your_feature_flag.md with generate_flag_enums.py

Browse Source 
generate_flag_enums.py was added a while back to help update enums.xml
(crrev.com/c/3912128). The tools/metrics/histograms/README.md was
updated back then. This CL updates docs/how_to_add_your_feature_flag.md.

Change-Id: Ie1ec936c293c30c0b16875ff39eb7088edd33f4f
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/4968776
Reviewed-by: Weilun Shi <sweilun@chromium.org>
Commit-Queue: Weilun Shi <sweilun@chromium.org>
Auto-Submit: manuk hovanesian <manukh@chromium.org>
Cr-Commit-Position: refs/heads/main@{#1214287}
This commit is contained in:
manukh
2023-10-24 17:26:01 +00:00
committed by Chromium LUCI CQ
parent 83cbd637bb
commit 3b041ffa30
1 changed files with 11 additions and 10 deletions

21
docs/how_to_add_your_feature_flag.md

@ -87,22 +87,23 @@ You have to modify these five files in total.
At first you need to add an entry to __about_flags.cc__,
__flag_descriptions.cc__ and __flag_descriptions.h__. After that, try running
the following test.
the following script which will update enums.xml:
```bash
# Build unit_tests
autoninja -C out/Default unit_tests
# Run AboutFlagsHistogramTest.CheckHistograms
# Updates enums.xml
./tools/metrics/histograms/generate_flag_enums.py --feature <your awesome feature>
# Run AboutFlagsHistogramTest.CheckHistograms to verify enums.xml
./out/Default/unit_tests --gtest_filter=AboutFlagsHistogramTest.CheckHistograms
# Run AboutFlagsHistogramTest.CheckHistograms on Android
# Run AboutFlagsHistogramTest.CheckHistograms on Android to verify enums.xml
./out/Default/bin/run_unit_tests --gtest_filter=AboutFlagsHistogramTest.CheckHistograms
```
That test will ask you to add several entries to enums.xml. After doing so, run
`git cl format` which will insert the entries in enums.xml in the correct order
and run the tests again.
You can refer to [this CL](https://chromium-review.googlesource.com/c/593707) as
an example.
*** note
**NOTE:** If CheckHistograms returns an error, it will ask you to add several
entries to enums.xml. After doing so, run `git cl format` which will insert the
entries in enums.xml in the correct order and run the tests again. You can refer
to [this CL](https://chromium-review.googlesource.com/c/593707) as an example.
***
Finally, run the following test.