doraskayo commented on code in PR #2095:
URL: https://github.com/apache/buildstream/pull/2095#discussion_r2666543505
##########
src/buildstream/source.py:
##########
@@ -572,14 +580,54 @@ def __init__(
The url of the source input
"""
+ self.concluded_license: Optional[str] = concluded_license
+ """
+ The license of the source project as declared by the authors
+ """
+
+ self.copyright_text: Optional[str] = copyright_text
+ """
+ Copyright notice of the source
+ """
+
+ self.declared_license: Optional[str] = declared_license
+ """
+ Licences that have been officially declared for the source
+ """
+
+ self.description: Optional[str] = description
+ """
+ Description of the source
+ """
+
+ self.external_reference: Optional[str] = external_reference
+ """
+ Reference to an external source of information or assets relevant to
the source
+ """
+
self.homepage: Optional[str] = homepage
"""
- The project homepage URL
+ The source's homepage URL
"""
self.issue_tracker: Optional[str] = issue_tracker
"""
- The project issue tracking URL
+ The source's issue tracking URL
+ """
+
+ self.name: Optional[str] = name
+ """
+ Name of the source
+ """
Review Comment:
Discard the above, I had missed the fact that the `provenance` configuration
was also added in https://github.com/apache/buildstream/pull/2095 to all source
plugins. It appears that this was not documented. This is where I would have
expected it to find it:
https://docs.buildstream.build/2.6/format_declaring.html#sources
The fact that the provenance fields are all user-configurable mostly covers
my concerns. I still think we should aim to populate the `name` field from
every core source plugin that can provide it reliably, but the fact that it's
user-configurable means there's always the option of specifying it manually.
I think it's worth to have this documented properly, however. I'll add a
separate comment about it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
