Skip to content

Documentation#105

Merged
maxhbr merged 3 commits into
mainfrom
documentation
Dec 15, 2025
Merged

Documentation#105
maxhbr merged 3 commits into
mainfrom
documentation

Conversation

@augelu-tng

@augelu-tng augelu-tng commented Dec 11, 2025

Copy link
Copy Markdown
Contributor

This PR includes a first draft for the documentation of the KernelSbom tool.

Signed-off-by: Luis Augenstein <luis.augenstein@tngtech.com>
Signed-off-by: Luis Augenstein <luis.augenstein@tngtech.com>
Signed-off-by: Luis Augenstein <luis.augenstein@tngtech.com>
@augelu-tng augelu-tng linked an issue Dec 11, 2025 that may be closed by this pull request

@maxhbr maxhbr left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some comments, still good

Comment thread sbom/README

$ export SRCARCH=x86
$ python3 tools/sbom/sbom.py \
--src-tree . \

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
--src-tree . \
--src-tree $PATH_TO_SRC_TREE \

@augelu-tng augelu-tng Dec 15, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The idea of this example is that the script is invoked from the src tree root. Therefore --src-tree .
When replacing it with $PATH_TO_SRC_TREE should we also replace tools/sbom/sbom.py with for example $PATH_TO_SBOMPY ?
I think this makes it more difficult to understand.
We could also just replace --obj-tree ./kernel_build with $PATH_TO_OBJ_TREE because this can actually change depending on how the kernel was built.

Comment thread sbom/README
$ export SRCARCH=x86
$ python3 tools/sbom/sbom.py \
--src-tree . \
--obj-tree ./kernel_build \

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
--obj-tree ./kernel_build \
--obj-tree $PATH_TO_OBJ_TREE \

Comment thread sbom/README
Comment thread sbom/README
@maxhbr maxhbr merged commit c011664 into main Dec 15, 2025
3 checks passed
@augelu-tng augelu-tng deleted the documentation branch December 19, 2025 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Write Documentation

2 participants