Skip to content

Commit 00ffa8e

Browse files
committed
Add documentation for pipeline
Signed-off-by: Tushar Goel <[email protected]>
1 parent 31eae95 commit 00ffa8e

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
@@ -58,6 +58,14 @@ Find Vulnerabilities (addon)
5858

5959
.. _pipeline_inspect_packages:
6060

61+
Inspect Elf Binaries
62+
---------------------
63+
.. autoclass:: scanpipe.pipelines.inspect_elf_binaries.InspectElfBinaries()
64+
:members:
65+
:member-order: bysource
66+
67+
.. _pipeline_inspect_elf:
68+
6169
Inspect Packages
6270
----------------
6371
.. autoclass:: scanpipe.pipelines.inspect_packages.InspectPackages()

docs/faq.rst

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

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

0 commit comments

Comments
 (0)