Skip to content

Conversation

@augelu-tng
Copy link
Contributor

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

  • Improved documentation.
  • Wrapped long lines.
  • Updated Copyright Header format

Signed-off-by: Luis Augenstein <luis.augenstein@tngtech.com>
@augelu-tng augelu-tng force-pushed the improve-documentation branch 2 times, most recently from 3a16a1b to 1db99ff Compare December 17, 2025 12:44
Copy link

@gregkh gregkh left a comment

Choose a reason for hiding this comment

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

Please keep a copyright line, that's fine, it's just this format that is not very commonly used in the kernel at this point in time.

@augelu-tng
Copy link
Contributor Author

How should I do it then ?
Would you prefer

# SPDX-License-Identifier: GPL-2.0-only OR MIT
# Copyright (C) 2025 TNG Technology Consulting GmbH

@gregkh
Copy link

gregkh commented Dec 17, 2025

That matches what most people/companies do, so yes, that looks fine.

@augelu-tng augelu-tng force-pushed the improve-documentation branch 2 times, most recently from 59d8291 to 68e34d8 Compare December 17, 2025 13:38
def _build_file_element(
absolute_path: PathStr, name: str, spdx_id: SpdxId, file_location: KernelFileLocation
) -> File:
def _build_file_element(absolute_path: PathStr, name: str, spdx_id: SpdxId, file_location: KernelFileLocation) -> File:
Copy link

Choose a reason for hiding this comment

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

Not a copyright change :(

kernel_file = KernelFile.create(
node.absolute_path, obj_tree, src_tree, spdx_id_generators, is_root
)
kernel_file = KernelFile.create(node.absolute_path, obj_tree, src_tree, spdx_id_generators, is_root)
Copy link

Choose a reason for hiding this comment

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

Not a copyright change :(

sbom/README Outdated

$ python3 tools/sbom/sbom.py --help


Copy link

Choose a reason for hiding this comment

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

Not a copyright change :(

file_location == KernelFileLocation.SOURCE_TREE
or file_location == KernelFileLocation.BOTH
)
if (file_location == KernelFileLocation.SOURCE_TREE or file_location == KernelFileLocation.BOTH)
Copy link

Choose a reason for hiding this comment

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

Not a copyright change.

sbom_logging.warning(
"Could not infer primary purpose for {absolute_path}", absolute_path=absolute_path
)
sbom_logging.warning("Could not infer primary purpose for {absolute_path}", absolute_path=absolute_path)
Copy link

Choose a reason for hiding this comment

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

I can go on... :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry for mixing up the changes.
Cleaned it up now.

…T license identifier

Signed-off-by: Luis Augenstein <luis.augenstein@tngtech.com>
Signed-off-by: Luis Augenstein <luis.augenstein@tngtech.com>
@augelu-tng augelu-tng changed the title Improve documentation Cleanup and Documentation Dec 17, 2025
Signed-off-by: Luis Augenstein <luis.augenstein@tngtech.com>
@augelu-tng augelu-tng force-pushed the improve-documentation branch from 68e34d8 to 600e4db Compare December 17, 2025 14:39
Signed-off-by: Luis Augenstein <luis.augenstein@tngtech.com>
@augelu-tng augelu-tng force-pushed the improve-documentation branch from 600e4db to 5cc5222 Compare December 17, 2025 14:41
@augelu-tng augelu-tng merged commit 2f217d3 into main Dec 17, 2025
2 checks passed
@augelu-tng augelu-tng deleted the improve-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.

3 participants