You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@buildstream.apache.org by "shymega-ct (via GitHub)" <gi...@apache.org> on 2025/09/15 19:48:07 UTC
[PR] docs/overlaps: Add 'Changing the location' section [buildstream]
shymega-ct opened a new pull request, #2060:
URL: https://github.com/apache/buildstream/pull/2060
- This adds a section about configuring some Element kinds for staging their dependencies in certain locations.
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs/overlaps: Add 'Changing the location' section [buildstream]
Posted by "shymega-ct (via GitHub)" <gi...@apache.org>.
shymega-ct closed pull request #2060: docs/overlaps: Add 'Changing the location' section
URL: https://github.com/apache/buildstream/pull/2060
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs/overlaps: Add 'Changing the location' section [buildstream]
Posted by "shymega-ct (via GitHub)" <gi...@apache.org>.
shymega-ct commented on code in PR #2060:
URL: https://github.com/apache/buildstream/pull/2060#discussion_r2691130549
##########
doc/source/handling-files/overlaps.rst:
##########
@@ -144,6 +144,29 @@ command contain an ``rm`` statement, as such:
This would cause later builds of ``runtime-only.bst`` to no longer
conflict on the given file.
+Changing the location
Review Comment:
Just wanted to follow up on this. I agree broadly with @gtristan on consolidating the documentation with a new page, but would like to hear @abderrahim and @juergbi's opinions too.
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs/overlaps: Add 'Changing the location' section [buildstream]
Posted by "gtristan (via GitHub)" <gi...@apache.org>.
gtristan commented on code in PR #2060:
URL: https://github.com/apache/buildstream/pull/2060#discussion_r2415824025
##########
doc/source/handling-files/overlaps.rst:
##########
@@ -144,6 +144,29 @@ command contain an ``rm`` statement, as such:
This would cause later builds of ``runtime-only.bst`` to no longer
conflict on the given file.
+Changing the location
Review Comment:
I believe it is also, separately documented in `ScriptElement` right ?
There are a couple (slowly growing number) of features which cannot be directly implemented on the `Element` class but are common amongst abstract subclasses, it *can perhaps* make sense perhaps to add a page to consolidate documentation for these common features on a single page...
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs/overlaps: Add 'Changing the location' section [buildstream]
Posted by "shymega-ct (via GitHub)" <gi...@apache.org>.
shymega-ct commented on code in PR #2060:
URL: https://github.com/apache/buildstream/pull/2060#discussion_r2725692197
##########
doc/source/handling-files/overlaps.rst:
##########
@@ -144,6 +144,29 @@ command contain an ``rm`` statement, as such:
This would cause later builds of ``runtime-only.bst`` to no longer
conflict on the given file.
+Changing the location
Review Comment:
Ack. Sounds good. I will merge that section, and the 'Changing the location' section in this PR together, in a suitable order.
For now, I will close this PR/discussion, and open a new PR next week.
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs/overlaps: Add 'Changing the location' section [buildstream]
Posted by "abderrahim (via GitHub)" <gi...@apache.org>.
abderrahim commented on code in PR #2060:
URL: https://github.com/apache/buildstream/pull/2060#discussion_r2709087741
##########
doc/source/handling-files/overlaps.rst:
##########
@@ -144,6 +144,29 @@ command contain an ``rm`` statement, as such:
This would cause later builds of ``runtime-only.bst`` to no longer
conflict on the given file.
+Changing the location
Review Comment:
It seems we have something about this topic in the [BuildElement API documentation](https://docs.buildstream.build/2.6/buildstream.buildelement.html#built-in-functionality) (the "Built-in functionality" section). It's hard to find given it's buried so deep in the docs.
I suggest we take this section and put it in a new page in the Using part of the documentation, as it's more of a user-facing thing.
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs/overlaps: Add 'Changing the location' section [buildstream]
Posted by "shymega-ct (via GitHub)" <gi...@apache.org>.
shymega-ct commented on PR #2060:
URL: https://github.com/apache/buildstream/pull/2060#issuecomment-3978244249
New PR here: https://github.com/apache/buildstream/pull/2103
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs/overlaps: Add 'Changing the location' section [buildstream]
Posted by "shymega-ct (via GitHub)" <gi...@apache.org>.
shymega-ct commented on code in PR #2060:
URL: https://github.com/apache/buildstream/pull/2060#discussion_r2355356300
##########
doc/source/handling-files/overlaps.rst:
##########
@@ -144,6 +144,29 @@ command contain an ``rm`` statement, as such:
This would cause later builds of ``runtime-only.bst`` to no longer
conflict on the given file.
+Changing the location
Review Comment:
I agree that it doesn't /really/ fit with the rest of the document. I
looked through the docs to find an alternative place, but none felt
like a good place.
I guess we could just keep the section in `BuildElement` and refer to
that from other documentation?
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs/overlaps: Add 'Changing the location' section [buildstream]
Posted by "abderrahim (via GitHub)" <gi...@apache.org>.
abderrahim commented on code in PR #2060:
URL: https://github.com/apache/buildstream/pull/2060#discussion_r2709087741
##########
doc/source/handling-files/overlaps.rst:
##########
@@ -144,6 +144,29 @@ command contain an ``rm`` statement, as such:
This would cause later builds of ``runtime-only.bst`` to no longer
conflict on the given file.
+Changing the location
Review Comment:
It seems we have something about this topic in the [BuildElement API documentation](https://docs.buildstream.build/2.6/buildstream.buildelement.html#built-in-functionality) (the "Built-in functionality" section). It's hard to find given it's buried so deep in the API docs.
I suggest we take this section and put it in a new page in the "Using" part of the documentation, as it's more of a user-facing thing.
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs/overlaps: Add 'Changing the location' section [buildstream]
Posted by "shymega-ct (via GitHub)" <gi...@apache.org>.
shymega-ct commented on PR #2060:
URL: https://github.com/apache/buildstream/pull/2060#issuecomment-3796904870
Closing in favour of a new PR. Will link to the new PR when ready.
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs/overlaps: Add 'Changing the location' section [buildstream]
Posted by "shymega-ct (via GitHub)" <gi...@apache.org>.
shymega-ct commented on code in PR #2060:
URL: https://github.com/apache/buildstream/pull/2060#discussion_r2487624136
##########
doc/source/handling-files/overlaps.rst:
##########
@@ -144,6 +144,29 @@ command contain an ``rm`` statement, as such:
This would cause later builds of ``runtime-only.bst`` to no longer
conflict on the given file.
+Changing the location
Review Comment:
I'm leaning towards consolidating documentation, but would like to reach a consensus amongst BuildStream developers.
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs/overlaps: Add 'Changing the location' section [buildstream]
Posted by "juergbi (via GitHub)" <gi...@apache.org>.
juergbi commented on code in PR #2060:
URL: https://github.com/apache/buildstream/pull/2060#discussion_r2415742170
##########
doc/source/handling-files/overlaps.rst:
##########
@@ -144,6 +144,29 @@ command contain an ``rm`` statement, as such:
This would cause later builds of ``runtime-only.bst`` to no longer
conflict on the given file.
+Changing the location
Review Comment:
> I guess we could just keep the section in BuildElement and refer to
that from other documentation?
Yes, I think it would be reasonable to add the information from this section to the `BuildElement` documentation as that's where `location` is documented. That said, the `BuildElement` documentation is a bit hidden as it's part of the Plugin API reference even though `location` is more relevant to project developers than plugin developers. I.e., maybe we could find a better place for the whole `location` documentation. However, moving that around is not directly related to expanding the documentation to cover the handling of runtime dependencies, so I suggest to first land the expanded documentation in `BuildElement` and then separately consider moving that section to a more relevant/discoverable part of the documentation.
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs/overlaps: Add 'Changing the location' section [buildstream]
Posted by "shymega-ct (via GitHub)" <gi...@apache.org>.
shymega-ct commented on PR #2060:
URL: https://github.com/apache/buildstream/pull/2060#issuecomment-3301720357
I agree that it doesn't /really/ fit with the rest of the document. I
looked through the docs to find an alternative place, but none felt
like a good place.
I guess we could just keep the section in `BuildElement` and refer to
that from other documentation?
On 16.09.2025 01:19, Abderrahim Kitouni wrote:
>@abderrahim commented on this pull request.
>
>
>
>> @@ -144,6 +144,29 @@ command contain an ``rm`` statement, as such:
> This would cause later builds of ``runtime-only.bst`` to no longer
> conflict on the given file.
>
>+Changing the location
>
>This section doesn't fit with the rest of the document. The document discusses an example project, while this section discusses a theoretical example that isn't well defined.
>
>I'm not sure what's the best way to deal with this. Extend the example project so that this can be applied? That could be too complicated for this tutorial. Move it to somewhere else in the documentation? I don't know where that could be.
>
>--
>Reply to this email directly or view it on GitHub:
>https://github.com/apache/buildstream/pull/2060#pullrequestreview-3228288291
>You are receiving this because you authored the thread.
>
>Message ID: ***@***.***>
Best regards,
--
Dom Rodriguez (he/him)
Software Engineer
Codethink Ltd
Codethink delivers cutting edge open source design, development and
integration services.
https://codethink.co.uk
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs/overlaps: Add 'Changing the location' section [buildstream]
Posted by "shymega-ct (via GitHub)" <gi...@apache.org>.
shymega-ct commented on code in PR #2060:
URL: https://github.com/apache/buildstream/pull/2060#discussion_r2361078924
##########
doc/source/handling-files/overlaps.rst:
##########
@@ -144,6 +144,29 @@ command contain an ``rm`` statement, as such:
This would cause later builds of ``runtime-only.bst`` to no longer
conflict on the given file.
+Changing the location
Review Comment:
@juergbi @gtristan What are your thoughts on a good way to place this section in the docs?
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org