gtristan commented on code in PR #1997: URL: https://github.com/apache/buildstream/pull/1997#discussion_r2055253546
########## src/buildstream/downloadablefilesource.py: ########## @@ -25,6 +25,46 @@ implementation. +Built-in functionality +---------------------- +The DownloadableFileSource class provides built in keys which can be set when +intantiating any Source which derives from DownloadableFileSource + +* Guess pattern + + This ``version-guess-pattern`` sets the regular expression which will be used to attempt + to guess the version of a source when parsing the source's URI. + + The DownloadableFileSource provides a default implementation of + :func:`Source.collect_source_info() <buildstream.source.Source.collect_source_info>`, + which will use the ``version-guess-pattern`` to attempt to extract a human readable + version string from the specified URI, in order to fill out the reported + :attr:`~buildstream.source.SourceInfo.version_guess`. + + The URI will be *searched* using this regular expression, and is allowed to + yield a number of *groups*. For example the value ``(\\d+)_(\\d+)_(\\d+)`` would + report 3 *groups* if 3 numerical values separated by underscores were found in + the URI. + + The default value for ``version-guess-pattern`` is ``\\d+\\.\\d+(?:\\.\\d+)?``. + + **Since: 2.5**. + +Built-in functionality Review Comment: This was a copy/paste error, that part was erronously carried over from the Source base class, fixed now. -- 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]
