juergbi commented on code in PR #2099:
URL: https://github.com/apache/buildstream/pull/2099#discussion_r2745459495


##########
src/buildstream/source.py:
##########
@@ -38,15 +38,11 @@
   to provide additional source provenance related metadata which will later
   be reported in :class:`.SourceInfo` objects.
 
-  The ``provenance`` dictionary supports the following fields:
+  The ``provenance`` dictionary itself does not have any specific required 
keys.
 
-  * Homepage
-
-    The ``homepage`` attribute can be used to specify the project homepage URL
-
-  * Issue Tracker
-
-    The ``issue-tracker`` attribute can be used to specify the project's issue 
tracking URL
+  Any attribute used in the ``provenance`` dictionary of a source must be
+  defined in the project.conf using the ``source-provenance-attributes`` 
dictionary
+  to define the attribute and its significance.

Review Comment:
   I think we should point to 
   ```
   :ref:`builtin defaults <project_builtin_defaults>`
   ```
   in case project.conf doesn't define a `provenance` dictionary.



-- 
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]

Reply via email to