Skip to content

Commit 195ebd6

Browse files
committed
Add documentation for pipeline
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
1 parent 35b271a commit 195ebd6

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

docs/built-in-pipelines.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,14 @@ Find Vulnerabilities
5252

5353
.. _pipeline_inspect_packages:
5454

55+
Inspect Elf Binaries
56+
---------------------
57+
.. autoclass:: scanpipe.pipelines.inspect_elf_binaries.InspectElfBinaries()
58+
:members:
59+
:member-order: bysource
60+
61+
.. _pipeline_inspect_elf:
62+
5563
Inspect Packages
5664
----------------
5765
.. autoclass:: scanpipe.pipelines.inspect_packages.InspectPackages()

docs/faq.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ Here are some general guidelines based on different input scenarios:
3939
use the :ref:`inspect_packages <pipeline_inspect_packages>` pipeline.
4040
- For scenarios involving both a **development and deployment codebase**, consider using
4141
the :ref:`map_deploy_to_develop <pipeline_map_deploy_to_develop>` pipeline.
42+
- For getting the DWARF debug symbol compilation unit paths when available from an elf binary.
43+
use the :ref:`inspect_elf_binaries <pipeline_inspect_elf>` pipeline.
4244

4345
These pipelines will automatically execute the necessary steps to scan and create the
4446
packages, dependencies, and resources for your project based on the input data provided.

0 commit comments

Comments
 (0)