simpleperf: clarify --binary_filter in report_html.py

Bug: 332623383
Test: report_html.py -h
Change-Id: Id2ee389c46db5c019004e20eb0b55d8bedebc324

2 files changed, 7 insertions, 1 deletions

diff --git a/simpleperf/doc/scripts_reference.md b/simpleperf/doc/scripts_reference.md
index d118ed2c..af74458e 100644
--- a/simpleperf/doc/scripts_reference.md
+++ b/simpleperf/doc/scripts_reference.md
@@ -151,6 +151,9 @@ $ ./report_html.py --add_disassembly
 # Adding disassembly for all binaries can cost a lot of time. So we can choose to only add
 # disassembly for selected binaries.
 $ ./report_html.py --add_disassembly --binary_filter libgame.so
+# Add disassembly and source code for binaries belonging to an app with package name
+# com.example.myapp.
+$ ./report_html.py --add_source_code --add_disassembly --binary_filter com.example.myapp
 
 # report_html.py accepts more than one recording data file.
 $ ./report_html.py -i perf1.data perf2.data
diff --git a/simpleperf/scripts/report_html.py b/simpleperf/scripts/report_html.py
index ba143fd0..b52f7af8 100755
--- a/simpleperf/scripts/report_html.py
+++ b/simpleperf/scripts/report_html.py
@@ -1027,7 +1027,10 @@ def get_args() -> argparse.Namespace:
     parser.add_argument('--disassemble-job-size', type=int, default=1024*1024,
                         help='address range for one disassemble job')
     parser.add_argument('--binary_filter', nargs='+', help="""Annotate source code and disassembly
-                        only for selected binaries.""")
+                        only for selected binaries, whose recorded paths contains [BINARY_FILTER] as
+                        a substring. Example: to select binaries belonging to an app with package
+                        name 'com.example.myapp', use `--binary_filter com.example.myapp`.
+                        """)
     parser.add_argument(
         '-j', '--jobs', type=int, default=os.cpu_count(),
         help='Use multithreading to speed up disassembly and source code annotation.')