IRC logs for #buildstream for Tuesday, 2018-03-20

*** tristan has joined #buildstream04:16
gitlab-br-botbuildstream: merge request (tristan/project-refs->master: Optionally load and store source references in project.refs) #314 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/31407:56
gitlab-br-botbuildstream: merge request (tristan/project-refs->master: Optionally load and store source references in project.refs) #314 changed state ("closed"): https://gitlab.com/BuildStream/buildstream/merge_requests/31408:11
gitlab-br-botbuildstream: merge request (tristan/project-refs->master: Optionally load and store source references in project.refs) #314 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/31408:12
juergbisorry, stupid gitlab08:12
tristan:)08:13
juergbiedited unfinished comment08:15
tristanand replied08:20
*** Prince781 has quit IRC08:20
tristanjuergbi, I think lets go with the former; merge them both to a `projects` key at toplevel08:22
tristanjuergbi, I was thinking, your self-junction use case might want to build the same element twice with different refs08:23
tristanBut...08:23
tristanThat should anyway be achievable with project options08:23
tristanand project name is a more natural choice I think08:24
tristanjuergbi, sound good ? ... maybe I'm missing something ?08:24
juergbitristan: only just now saw the messages08:30
juergbiyes, i'm not hard set on either option. going with the former is fine with me08:30
tristanright, should have that done in an hour or maybe two I think (test cases and docs need updating)08:31
juergbiok. i think the rest looks good08:35
tristanoops, just found an internal api docs problem I'll fix too08:39
tristanSource._save_ref() has completely wrong API docs08:40
tristannot completely, just *mostly* wrong :)08:41
juergbioops, didn't look too closely at that08:41
juergbifocused on the big picture :)08:41
tristanI'm happy with test coverage08:48
tristanThe actual code changes are rather small, but the edge cases to cover are many08:49
jennistristan, !327 and !323 have been reviewed, both regard documentation, would you be able to have a look?09:12
tristanjennis, give me... around 30min... and if you're available let's have a chat about that too09:15
jennistristan: sure :)09:16
*** ernestask has joined #buildstream09:24
gitlab-br-botbuildstream: merge request (tristan/project-refs->master: Optionally load and store source references in project.refs) #314 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/31409:29
*** jonathanmaw has joined #buildstream09:36
gitlab-br-botbuildstream: merge request (278-filter-documentation-could-be-better->master: Resolve "Filter documentation could be better") #304 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/30409:48
gitlab-br-botbuildstream: merge request (278-filter-documentation-could-be-better->master: Resolve "Filter documentation could be better") #304 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/30409:49
tristanOK - let's pull the trigger on project.refs !09:50
gitlab-br-botbuildstream: issue #248 ("Do not automatically update git checkout with refs") changed state ("closed") https://gitlab.com/BuildStream/buildstream/issues/24809:50
gitlab-br-botbuildstream: merge request (tristan/project-refs->master: Optionally load and store source references in project.refs) #314 changed state ("merged"): https://gitlab.com/BuildStream/buildstream/merge_requests/31409:50
gitlab-br-botbuildstream: issue #248 ("Do not automatically update git checkout with refs") changed state ("closed") https://gitlab.com/BuildStream/buildstream/issues/24809:50
*** aday has joined #buildstream09:51
jonathanmawHi tristan, do you have time to look at whether https://gitlab.com/BuildStream/buildstream/merge_requests/304/diffs resolves the issue you had with the filter element's documentation?09:56
jonathanmawHi juergbi, do you have time to look at https://gitlab.com/BuildStream/buildstream/merge_requests/317 ?09:56
juergbiplanning to review the pending MRs today, yes09:57
jonathanmawtvm juergbi09:57
*** jmac_ has quit IRC10:10
tristanjonathanmaw, comments up on 30410:14
jonathanmawta tristan10:15
*** dominic has joined #buildstream10:24
*** jmac has joined #buildstream10:28
tlaterHm, I'm looking at a proposal from ssssam[m] and Nexus to make the full "~/.cache/buildstream" directory size quota-able10:37
tlaterWhich goes into the detail of managing the size of sandbox directories and such10:37
Nexusah yes, that10:38
tlaterThis definitely solves a few issues #135 currently doesn't cover, but it does seem like simply expiring cache elements would be enough to at least get gnome adoption down10:38
tlatertristan: What's your opinion on ^ ?10:38
* tlater thinks the more full solution would take a fair bit longer.10:39
tristantlater, one thing at a time I believe11:06
gitlab-br-botbuildstream: merge request (278-filter-documentation-could-be-better->master: Resolve "Filter documentation could be better") #304 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/30411:07
tristantlater, ~/.cache/buildstream/build area should be solved by the "caching failed builds" issue anyway; there's not much point in leaving those on disk when *anyway* we are supposed to have a plan for reconstructing a failed build sandbox regardless if it happened locally or remotely11:07
tristansources are going to be a different beast, but I think they are of least concern here11:08
jonathanmawtristan: I've updated my documentation change. I'm not entirely sure I understand the main intent of your comment, as I'm not sure of the fine points between "this element expects $foo" and "it is useful to do $foo for $reason"11:08
NexusSo, i'm looking into implementing the "Build Tree Caching" Do we want to have the enabled/disabled arguement in the user config or the project config?11:21
juergbii believe it needs to be project config and even affect the cache key11:22
juergbiif we make the build tree part of the artifact11:23
juergbi(unless we make it unconditional after all)11:23
tlaterjuergbi: It should definitely contain the build tree sha, no?11:24
tlaterOtherwise we could create the same artifact twice, but have it contain different build trees11:24
juergbiif it's part of the artifact, the build tree sha will be in the merkle tree anyway11:25
juergbibut the build tree sha shouldn't be in the cache _key_11:25
* paulsherwood thinks that 'tree' is being used too many ways these days11:26
Nexus*cahing of the build directory created in the sandbox*11:27
*** sstriker has joined #buildstream11:30
juergbiyes. I'm used to git's tree objects and I quite like it but it's somewhat ambiguous11:30
paulsherwood+111:36
gitlab-br-botbuildstream: merge request (issue-243_dpkg_import_source_plugin->master: Created DPKG Source plugin for Issue #10) #305 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/30511:43
laurencenot sure how to add related MRs to issues on gitlab, but I think that !315 and !313 should be linted to #215, tlater11:43
laurencesorry if i'm being anal11:43
tlaterlaurence: No, you're right - I created the MRs from branches automatically created by gitlab, so I figured they'd be linked11:44
tlaterTurns out that doesn't quite work as expected11:44
tlaterta for the note!11:45
Nexusjuergbi: re: rename the plugin from `dpkg` to `deb`11:48
Nexusi don't see any issue with this, i wanted to see if anyone else had concerns11:49
juergbijjardon[m] and tlater added a thumbs up on gitlab11:51
juergbii haven't heard any concerns of a rename11:51
Nexuskk, then i'll go ahead with the rename11:51
juergbita11:52
gitlab-br-botbuildstream: issue #95 ("please provide some real examples") changed state ("closed") https://gitlab.com/BuildStream/buildstream/issues/9512:05
gitlab-br-botbuildstream: merge request (issue-243_dpkg_import_source_plugin->master: Created DPKG Source plugin for Issue #10) #305 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/30512:06
Nexusjuergbi: Are we assuming that, if no key is set in the project conf for `build tree caching`, it is disabled?12:07
juergbiI don't know. the optionality is to be decided12:07
tristanjennis, I'm very sorry; I will be with you shortly...12:07
tristanjennis, are you around ? or did I fall flat into your lunch hour ?12:22
jennisi'm here!12:24
jennistristan ^12:24
tristanAh12:27
*** aday has quit IRC12:27
*** aday has joined #buildstream12:28
tristanjennis, sigh; ok - I've had a lot of communications today - and the docs story is always a nightmare12:28
tristanwe are bottlenecking with "I have so many docs patches to throw at you" but "I have not proposed a real long term plan of how the documentation will be structured !"12:29
jennisno worries tristan, the good news is that is that the branches contain relatively small changes that are going to more of a kick start12:29
jennisbranches related to !323 and !32712:29
tristanjennis, 327 looks non-controversial to me; I like the current theme, but if people want it to look like readthedocs, so be it12:30
tristanI find it petty, but whatever12:30
tristanit changes the theme, but it does not make the sidebar suddenly become useful; that is something we probably want to fix12:31
tristanjennis, the problem with 323 on the other hand is, this is a lot of changes thrown at us in a single patch12:31
jennisThere does seem to be a "depth" difference12:31
tristanI dont like reviewing 323 as a single change, that can be a long time to land; at first sight, I dont like that the "What is BuildStream" has become, especially that it lists stuff like "Right now we can do foo, bar and baz !"12:32
jennisquickly back to !327, I thin the theme deals with navigation in a *slightly* better way12:34
tristanSo, actually I dont want to land 323 at all before we have a plan12:35
gitlab-br-botbuildstream: merge request (jjardon/theme_change->master: Change theme to sphinx_rtd_theme) #327 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/32712:35
Nexustristan: Do you have any thoughts on the "Should caching the build tree be optional?" If so what should the default be?12:35
gitlab-br-botbuildstream: merge request (jjardon/theme_change->master: Change theme to sphinx_rtd_theme) #327 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/32712:35
jennise.g. if I click go to "installing buildstream" I've then lost sight of "BuildSteam inside docker" and "using buildstream" in the ToC12:35
tristanjennis, I dont think the docker part was in the ToC, and !327 changes something else *besides* the theme12:38
tristanwhich is misleading and sneaky of jjardon[m] :)12:38
jennisTo add to this, if you go to "Using BuildStream" in the current documentation, you lose the ToC completely https://buildstream.gitlab.io/buildstream/main_using.html#main-using12:38
jennisahh ok12:38
jennisWell, that said, I feel that not losing sight of the top level is important12:38
tristanactually, I dont see how that can apply on master's doc/source/index.rst12:39
tristanit's changing lines which I dont even see12:39
tristanaha, after rebase it looks like that patch has changed, is gitlab lying to me ??12:41
tristanAh ok I see12:42
tristanjennis, so yes; this is a sneaky commit12:42
tristanthe commit says it changes the theme, but it changes doc/source/index.rst to use a different way to express the toctree12:43
tristanWhich *seems* like it makes the sidebar different12:43
jennisOk, so we agree this is a commit that should be merged regardless of the theme?12:43
tristanYes, I'd like to see it first, and honestly I never knew how to do that with the toctree stuff12:44
jennisaha yes it's good12:44
tristanjennis, if you are going to be my docs lieutenant for the time being; I will just trust you on that part12:44
tristanI'd rather postpone the "Lets make it look like readthedocs !!!" thing, to be honest12:45
jennisRight ok, i'll do an MR with this ToCtree change but no themechange12:45
jennisand we'll see how that looks?12:45
jennisBack to !323?12:46
tristanjennis, am I to trust that you are going to be my point of contact for getting docs off the ground ?12:46
jennisyes, I think jjardon[m] has a lot to say too12:46
tristanexcept he is not working on this; and I need a clear vision to come from one person12:47
jennisSure, yeah you can trust me"12:47
jennis!12:47
tristanjennis, Once we iron out the question of structure, then smaller isolated patches which add the docs we want to the places that are correct, will be easy to review12:47
jennisI agree12:48
tristanbecause, there will be already a "place that is correct"12:48
tristannow it's still mayhem12:48
jennisSo we need to establish and agree on some structure from top level ASAP12:48
jennisWhich is what !323 is attempting to do12:48
tristanwell, !323 is not discussing that or attempting that at all12:51
jennisIt alters the top level structure12:51
tristanit's adding new sections, rephrasing "What is BuildStream", and swapping things around; all in the same MR12:51
tristanwhich is just too much noise right now12:51
tristanlets completely forget that 323 exists12:52
tristanfirst we talk about structure, including even naming of .rst files12:52
jennisRight ok, we'll go from here then12:52
tristanI had started out by trying to make some consistency with my sub-level main_foo.rst files12:52
tristanthe rest of them are still a bit of a mess12:52
tristanit's hard to tell where they are structurally, anyway12:53
tristanjennis, so first we need to think about *what*, what is the big picture of what will be documented12:53
tristanThere is a patch from months ago which splits up invoking.rst into one section per bst command12:54
tristanjennis, I want to leverage automation in docs as much as possible, so it would be nice to apply that and have some use for it12:54
tristanI.e. that patch allows for the auto-generated `bst --help` style invocations to be *explained* in sections, and link out to other docs, or be linked *from* other docs12:55
tristanjennis, so that is one thing; we want to document what the commands are for, and be able to link to them from places12:55
tristanthis allows people to "dig" through links in a nice and interesting way12:56
tristanjennis, another thing we need is, related to authoring projects; some examples of how to do various things12:56
jennisOk, first point of action could be to sensibly rename the other files so that they reflect our current structure12:57
jennis?12:57
tristanjennis, one thing I liked from paulsherwood's attempt last week, was that he started with the "manual" element12:57
tristanjennis, I am trying to give you a bunch of information which you are taking notes about, so that you can form a plan to feed back to me12:58
jennisright12:58
tristanso what I liked about starting examples with the "manual" element, is that it necessarily uses some variables, like say %{install-root}, and it explicitly sets build-commands, configure-commands etc12:59
tristanIf we're going to have a "getting started" section, we should start with a "manual" element and move on to another, say "autotools" element12:59
tristanThis helps teach the user what variables are doing; with most elements, we only need to set some variables13:00
tristanbut the user should understand *how this impacts build-commands*13:00
tristanjennis, so stepping back a second, we've talked about so far, two "things"13:00
tristanone is the invoking.rst autogenerated content; i.e. "What the commands do"13:01
tristanAnd, now we're talking about a "Getting started" guide13:01
jennisyes, following :)13:01
tristanthe "Getting started" guide should not be too elaborate, and it will not be enough13:02
tristantoo much getting started sends the signal that, you will never get started13:02
tristanbut it *cannot* cover everything, it should be enough to teach the user how to find out what they need to know, beyond that13:02
tristanI recall years ago learning Cocoa/Obj-C/Xcode in a matter of days - with a 12 page "Getting started" guide13:03
jennisIt should include Paul's helloworld example also13:03
tristanjennis, it *can*, but I will say off the bat, I very much dislike what I'm seeing in 323 as an adaptation of that13:04
tristanI.e. it takes some shell script and dumps it into some literal thing13:04
jennisYes, one of my comments was to have more of a walkthrough of this13:05
tristanthis stuff needs to be *authored*, lets not start off with... just dumping terminal stuff13:05
tristanWe should not be showing "echo blabla > foo.bst" here13:05
jennishowever we decided that could be implemented in another branch after this landed13:05
tristanWe should be presenting a foo.bst in the docs, using the `.. code:: yaml` blocks13:05
jennis^ I totally agree13:06
tristanRight, I disagree, I dont want to shove crap in the repo13:06
tristan323 should not land, really13:06
jennisRight ok13:06
tristanBeyond a getting started guide, we may want some more elaborate examples... "How do I" style13:07
tristanThis is interesting for multiple reasons,  A.) They are isolated pages which a contributor can send nicely isolated patches for13:07
tristanB.) They can link out to eachother for explanations of things which they may need to know before understanding the particular article13:08
tristanC.) They are an extension of Getting Started, without putting too much weight on Getting Started, which needs to be a bit of a walkthrough13:09
tristanWe want the walkthrough to be very brief13:09
tristanOr, *I* think we do13:09
tlaterOn that note, we created the bst-examples repo with this sort of doc in mind - any way to tie that in?13:09
tristantlater, probably; I dont like having docs in separate repos; that means we cannot block branches on proper amendments to documentation13:10
* tlater has understood that at this point, and agrees we should avoid it 13:11
tlaterBut I also think it's useful to have these walkthrough projects available in a repo, so the reader can clone and run-along13:11
tristantlater, *yes*13:12
tristantlater, buildstream projects are lightweight; we can have 50 of them in the main documentation and it will not make the repo undesirably "big"13:12
tristanAlso, we should be running CI on our examples, not for the sake of testing BuildStream, but for the sake of testing our examples do what we expect them to13:13
tristanjennis, so literal includes like we do with several things is a very nice thing for this kind of example13:13
tristane.g., how we do it for every single element, literal include the accompanying .yaml file13:14
gitlab-br-botbuildstream: merge request (issue-243_dpkg_import_source_plugin->master: Created DPKG Source plugin for Issue #10) #305 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/30513:16
tristanjennis, so now there are 3 things13:17
tristan1.) Explanation of commands  2.) Getting started brief walkthrough  3.) Examples13:18
gitlab-br-botbuildstream: merge request (278-filter-documentation-could-be-better->master: Resolve "Filter documentation could be better") #304 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/30413:18
jennissorry i Was taking notes13:19
tristanjennis, I feel that 2 and 3 belong close to eachother in the ToC13:19
tristanNo worry, I'm glad you are taking notes13:19
tristanchannel is also logged, you may want to hold on to: https://irclogs.baserock.org/buildstream/%23buildstream.2018-03-20.log.html13:20
tristanlink for today13:20
jennishaha thanks, I have the logs saved locally as well13:21
jennisI've noted all that. I will draft some sort of POA after lunch and send it to you. There are also some changes that I think can/should be made ASAP to our structure13:22
tristanjennis, one point of contention is going to be "What do we include in Getting Started ?"13:24
jennisNamely, one of the changes that !323 tried to implement: Splitting Documentation into "General documentation and "Reference documentation"13:24
tristanThis should be derived at least in part by what we want to teach the user as the very basic knowledge13:25
jennisAnd also introducing the Getting Started Section13:25
tristanLast time I restructured, I made three sections; Using, Authoring Projects, Authoring Plugins13:25
tristanthe authoring plugins is named differently, core reference or such13:26
jennisyes13:26
tristanwhich reminds me, there is a FOURTH thing13:26
jennisUnder the Documentation Section13:26
tristanWe have some API docs, but we dont have nice, clear explanations of what the Elements and Sources *have to do*13:26
jennisNow I'm asking if you think we should have Installing, Getting started, Documentation and Indices and tables as Sections within index.rst13:27
tristanFor the format documentation, we are pretty tight, though; I think for that part we are really close to 100% well documented13:27
tristanThis is of course, only useful to someone who has already gotten started :)13:27
tristanWell13:28
tristanjennis, I'm not sure; you want to split out project authoring and plugin authoring into something separate ?13:28
gitlab-br-botbuildstream: merge request (215-workspace-builds-might-not-rebuild-correctly-when-dependecies-are-updated->master: WIP: Resolve "Workspace builds might not rebuild correctly when dependecies are updated") #315 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/31513:29
tristanjennis, I think that's okay, perhaps lets call that "Reference Documentation"13:29
gitlab-br-botbuildstream: merge request (jjardon/misc_fixes->master: Some little documentation fixes) #326 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/32613:29
jennisAnd then Getting started to go under Documentation or to be it's own section?13:29
tristanjennis, Also, off the top of my head I think: Installing, Getting Started, Examples, Using (invoking.rst), Reference Documentation13:30
jennisok13:31
tristanOr, maybe Using belongs under "Reference Documentation" as well, that one is a bit ambiguous13:31
jennisAtm: using, authoring projects, authoring plugins, is all under "Documentation"13:32
tristanReference Documentation is exactly that, though; it's where you go to remember something when you need13:32
tristanAh; I'm not even thinking in that sense13:32
tristanjennis, rather I'm thinking, these are main toplevel links which bring you to individually focused pages13:32
tristanjennis, the titles on the main page rather separate things, they are rather immaterial13:33
tristanthey separate the important main links from "What is BuildStream", mostly13:33
tristanjennis, so I'm thinking, when you hit that main page, you are not bombarded with details of reference documentation; instead you are presented with a simple choice, red pill or blue pill13:34
jennisI agree with that, but I also disagree with the titles being immaterial, they should clearly and simply represent what you can find from this main page13:35
jennisBut I will create a plan and a couple of MRs and see what you thin13:35
jennisthink13:35
tristanjennis, I mean the headings on the main page - they are not a "node" in the ToC tree in my mind13:36
tristanjennis, I am saying this because it *completely* changes the context of what we have been talking about just now13:36
tristanI am thinking about nodes in which you dig13:36
tristanwell, maybe it does not change it *that* much13:37
jennisok, there is plenty of information here for me to digest + create some kind of plan13:38
tristanjennis, Alright; I look forward to a more complete proposal / game plan from you13:40
tristanjennis, and I will be grateful to have a single point of contact / lieutenant for this effort, this makes things much easier and streamlined for us to get off the ground13:41
tristanjennis, two last points...13:45
tristanjennis, first, lets use the alpine image which ssssam[m] cooked up for our integration tests, it is currently the smallest, and thus the fastest runtime to obtain13:45
tristani.e. for any getting started material, and (ideally) for examples as well13:46
tristanalso, it will suck if we have to start having many different images13:46
tristanideally, we would rather use a bootstrap image from the freedesktop-sdk project; because that's an image built by BuildStream13:47
tristanjennis, but that can be a separate effort; when freedesktop-sdk provides a nicely trimmed output that is fairly small, we can swap out alpine for it *across the board*13:47
tristanjennis, second point: well it's not really a point, but I want you to think about what we are going to achieve in "Getting Started", i.e. what things will we teach the user, and what kind of elements we're going to use13:48
tristanI think something simple like; building something on top of the alpine image, using both the manual style first, and then say; building the same thing with autotools...13:49
tristanand workspacing the code, making a change to the code, and using `bst shell` to launch it an debug it13:49
tristanshould be rather enough, but there can and will be conflicting views :)13:49
jjardon[m]tristan new theme doesn't work correctly if you don't change the TOC stuff13:50
tlater"We should cover the details of bst source-bundle"13:50
tlater;P13:51
tristanjjardon[m], but the TOC changes improve things without changing the theme, right ?13:51
tristantlater, and we should have test coverage for that... and I'm sure toscalix would like to use a variety of `bst source-bundle` for the purpose of compliance, i.e. "just the sources, and exactly these sources" but perhaps without the generated build scripts13:52
tristantlater, would also be nice if `bst source-bundle` does *not* include things like... the .git/ subdirectory of git repos; does it already do this ?13:53
tlaterI frankly don't remember13:53
tristanseems an interesting thing compliance-wise... lets make a tarball of "all the sources which exactly went into this"13:53
tristanyeah, it was a while ago13:53
gitlab-br-botbuildstream: merge request (issue-243_dpkg_import_source_plugin->master: Created DPKG Source plugin for Issue #10) #305 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/30513:53
tristanit makes up for a good amount of our ~17% of code that is still not covered by tests13:53
tlaterIt certainly needs a refactor too13:54
tlaterDo we have an open issue for this yet?13:54
jjardon[m]tristan "lets completely forget that 323 exists" this doesn't encourage me or any other contributor to spend time trying to fix sonething13:54
tristantlater, check13:54
* tlater can't find one13:54
jjardon[m]Which has been broken for months now BTW13:55
tristanjjardon[m], it's too much for me to handle, changes too many things; docs has been a big issue, read the backlog if you want to understand13:55
tristanjennis, it's closing time here, but I think we're off to a good start13:55
*** tristan has quit IRC13:58
jjardon[m]Wherever is in those commits is way better to what we have now14:03
jjardon[m]I don't understand why we can not merge that and keep improving in posterior mr14:03
*** tristan has joined #buildstream14:04
jjardon[m]Instead waiting some days/weeks/ months to have the perfect documentation14:04
tristanjjardon[m], I'm sorry if you feel discouraged, there are too many separate things, most/all of which I believe are not good enough to land yet14:05
tristanYou may think "its better than nothing", I disagree, and wont land stuff before it's done well14:05
jjardon[m]Its better than the current docs14:06
jjardon[m]Not nothing14:06
tristanjjardon[m], 323 specifically, also does a lot of separate stuff at once, which means reviewing it is not an efficient use of time, some changes might be ready to land, while others will just block the whole thing.14:06
jjardon[m]But I guess we have to agree to disagree14:06
tristanjjardon[m], finally, jennis is going to be running point on docs until we at least ramp up and have structure and policy14:07
tristanhe will be incorporating parts of 32314:07
jjardon[m](I'd feel the same if they were other person patches BTW)14:07
jjardon[m]Please update the MR's with what the current plan is , at least people that take a look there know what is happening14:09
tristanjjardon[m], to respond to what I had missed while moving away from coffee shop... "I don't understand why we can not merge that and keep improving in posterior mr"14:09
tristanWe dont do things that way around here, basically.14:09
tristanWhen something is added, it should not require improvements until it does - if we were to work that way, then at least 80% of the incomplete stuff that we land on master, will never be improved14:10
tristanThat is from experience, it's just a natural effect of letting stuff land14:10
tristanSo, people may think that I don't care enough about docs, it's the opposite; I care a great deal.14:11
gitlab-br-botbuildstream: issue #310 ("`bst source-bundle` should get better documentation and receive test cases") changed state ("opened") https://gitlab.com/BuildStream/buildstream/issues/31014:12
* tristan goes to obtain a late night dinner.14:12
tlatero/ tristan14:12
dominicCan I just confirm that with issue #286 that it's going to be a fix on bubblewrap that we want upstream14:12
tristandominic, issue says "We should upstream a patch for this and then conditionally start using the feature in BuildStream on sites which have a recent enough version of bwrap."14:13
tristandominic, we cannot close 286 until we have done both parts of that sentence14:14
tristandominic, it also implies that we need to start version checking bwrap, which we have been careless about; but we still use only bwrap CLI args that are available since... a very long time.14:14
tristan(except one case, where we feature test for it instead, which juergbi added; that should be transformed into a version check at the same time)14:15
* dominic nods14:15
dominicty tristan14:15
tristan:)14:15
jjardon[m]tristan the MR about the docs can go as it is. Its notthing incorrect about it, althoug of course it can be improved14:18
jjardon[m]tristan as I said, the sedult would be much better than what we currently have now14:18
jjardon[m]tristan and I care about this too, if not I would not have spend my thrusday evenenin doing it14:19
jjardon[m]tristan and btw, Im not suggesting merge it as is; it already include modification jennis have suggested. But hold on improving something that is curently broken because we want to have something much better I do not think is the best approach14:21
jjardon[m]tristan Its my opinnion, as I said before we can agree on disagree14:22
gitlab-br-botbuildstream: issue #278 ("Filter documentation could be better") changed state ("closed") https://gitlab.com/BuildStream/buildstream/issues/27814:33
gitlab-br-botbuildstream: merge request (278-filter-documentation-could-be-better->master: Resolve "Filter documentation could be better") #304 changed state ("merged"): https://gitlab.com/BuildStream/buildstream/merge_requests/30414:33
*** Prince781 has joined #buildstream14:37
laurenceskullman, something I should have mentioned earlier: landing 'UI for inspecting build logs and failed builds from the artifact cache' is dependent on 'Caching Build Tree' which Nexus is currently working on.14:51
laurenceI don't *think* you'll be blocked at all though, as I imagine development can start already without Build Tree Caching being implemented14:52
skullmanlaurence: AIUI the majority of the work is not going to be dependent on Caching Build Tree.14:54
laurenceskullman, great14:55
tristanjjardon[m], as I mentioned in the conversation above, I dont like changing the "What is BuildStream" to start mentioning such specifics, I also would not accept the example paulsherwood came up with the way it was presented; in needs explaining and proper formatting, not using "echo foo > foo.bst" in the example, the fact that this comes with a re-organization of the ToC right now, when jennis is about to prepare a more complete plan for14:55
tristanorganizing of things, doesnt help either14:55
tristanjjardon[m], the timing is actually bad, because accepting docs patches will become much easier once jennis has gotten us off the ground14:56
jjardon[m]tristan "What is Buildstream" was not changed in the initial MR, it was something actually suggested in the review14:56
jjardon[m]tristan tell me in the review to remove the Paul example then, or improve it14:57
tristanjennis, also, you might want to consider doing work on a `documentation` side branch for the time being, if people are going to be submitting patches against docs a lot during this time, they should probably be making merge requests targetting your side branch14:57
tristanjjardon[m], no, it's under jennis's control, not mine, until things are up and running he is the point of contact for general documentation14:58
jjardon[m]???14:58
jjardon[m]he was the one reviewing and  accepting the MR as they are?14:59
tristanjjardon[m], yes, this is what we have been discussing today, until we have structure layed out, he is going to be documentation lieutenant14:59
* jjardon[m] confused14:59
tristanjjardon[m], not on master14:59
tristanjjardon[m], I know people are frantic about docs now, but jennis is working on a plan, that is going to be solved before we start landing things on master15:00
tristanwhat you and jennis have been discussing in MRs, I have not been watching15:00
jennistristan, could that not lead to the side "documentation" branch getting clogged with changes that we don't want15:01
tristanjennis, only if you hurry to land things that you do not find to be ready15:01
tristanjennis, if you are the point of contact for this effort, you are maintainer of that branch until it's merged, if you accept that people contribute to your branch in that period, that is fine with me15:02
jennistristan, ok, let's see how that goes15:03
tristanFirst we discuss structure and planning once you present your plan, when you think the first steps are ironed out in your branch, I'll spend the time to make a thorough review of that15:03
tristanjennis, you are not obligated, but you have expressed that you are incorporating jjardon[m]'s changes, if I understood correctly15:03
jennisOk, also before all that, before I do this, we agreed that the changes made to the ToCTree were something that can be merged ASAP on its own branch?15:04
tristanSo, for the time being, when it comes to patches for doc/source/* that is not related to existing well defined docs (i.e., all of this extra stuff), I am not going to take care of until we land your work.15:04
jennis^^ ok no worries15:04
tristanjennis, we did, and if the theme change also has a practical benefit; i.e. it actually works on mobile and the current theme does not; then we can land that too15:05
jennisbut just to clarify, it's changes like this you would expect in two different MRs? Or you're ok with two clear commits15:06
jjardon[m]tristan if you have looked to the MR, you could see that I have reworking things jennis have suggested. Seems that we have a new plan now; please update the MR so everyone is aware15:06
tristanjennis, this change I felt that; it makes the ToC better, i.e. the side bar becomes suddenly more useful - but this does not seem to require changing the theme, it still improves the sidebar15:07
tristanjennis, please update the MR15:07
tristanas jjardon[m] requests.15:07
jjardon[m]tristan jennis I have tried to change the sidebar only: it doesnt work in the current theme15:08
tristanah, I thought jennis tried that earlier15:09
tristanjjardon[m], does the side bar expand/collapse on mobile ?15:09
tristanif so, I'm sold to land that right now15:10
tristanjennis, before I start eating, I should clarify regarding merge requests...15:10
tristanjennis, *your* branch will be one merge request, with probably many commits (no need to create an MR and spam the channel until it's close to ready)15:10
jennisNo I was going to try it now15:10
jjardon[m]tristan with the new theme? I have not tried but other pages with that theme it does15:11
tristanjennis, however - we want to keep this exercise as quick as possible, so that means; we decide on policy, effect structural changes to the docs in your branch, and add the minimum amount of *ready* material15:11
jennisright agreed15:12
tristanjennis, i.e. we want a policy in place so that we can more effectively consume docs patches, and people submitting them find some structure, and that's it15:12
tristanyeah, we're on the same page; I didnt want people in channel to think this was going to be a long dragged out affair :)15:12
jennisgood stuff, I'll send you the plan once it's done15:13
tristanjennis, we'll just merge !327 with the theme change - with an update to the HACKING file15:23
tristandont bother splitting that, as jjardon[m] mentioned, the ToC stuff also doesnt work without theme change15:24
tristanI think there is a stray commit in another branch which fixes doc/source/conf.py to report the correct version, now that it appears in that new theme it would be good to apply that straight away too.15:25
jennisThe stray commit was in !32615:27
jennisSo are both being merged?15:28
jennis!326 involves the conf.py change you mentioned as well a couple of title changes within install.rst15:29
tristanjennis, I mean the commit which does that in !32615:30
jennistristan, unless you're opposed to the title changes, it should be find to merge both15:30
tristanI was going to cherry pick it myself, but resisted the temptation because it doesnt change the docs at all; it does with the new theme, though.15:31
tristanjennis, looks like other comments are addressed there, so yeah whole branch can land too :)15:32
juergbiit also fixes the 0.1 version in the title, i presume15:32
tristanjuergbi, ah, I missed that part :)15:32
tristanjuergbi, wasn't looking at my browser's page title15:33
gitlab-br-botbuildstream: merge request (jjardon/theme_change->master: Change theme to sphinx_rtd_theme) #327 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/32715:33
gitlab-br-botbuildstream: merge request (jjardon/theme_change->master: Change theme to sphinx_rtd_theme) #327 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/32715:35
NexusI'm currently working on implementing the caching of build trees. Where would put the tests to check that my changes work?15:43
Nexusjuergbi, tlater any thoughts?15:45
* tlater has forgotten the end goal of the build tree caching15:45
juergbiprobably need an integration test15:45
tlaterDo we want the user to ever look at it?15:45
juergbiit's a mechanism with multiple end goals15:46
juergbione is for incremental build right after opening a workspace15:47
juergbianother is inspecting a failed remote build15:47
juergbiand another is incremental non-workspace builds15:47
jennisok, tristan I don't have permission to merge btw, do you mind doing ity15:47
tlaterBut I suppose none of this will be added in Nexus' branch15:48
tlaterHm, that makes it a bit tricky to test15:48
Nexus:(15:48
juergbimaybe add the first one in the same MR?15:48
juergbimight be simple enough15:48
juergbiwe generally anyway don't want to add internal features that are not used yet15:49
*** valentind has joined #buildstream15:52
Nexusjuergbi: so what is it id have to do? is there an issue i can look at?15:56
juergbiI don't see an open issue about this15:59
juergbithe basic idea is that 'bst workspace open' will populate the workspace with the cached build tree to allow incremental build16:00
gitlab-br-botbuildstream: merge request (issue-243_dpkg_import_source_plugin->master: Created DPKG Source plugin for Issue #10) #305 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/30516:01
juergbiit's actually mentioned in #2116:01
gitlab-br-botbuildstream: merge request (jjardon/misc_fixes->master: Some little documentation fixes) #326 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/32616:04
tristanjennis, now you do16:07
tristanat least for now16:07
tristan:)16:07
jennisaha thanks, I've just found a typo which I'm going to fix as part of that branch16:09
Nexusjuergbi: please could you create an issue for me, so i can get a better understanding of what's needed and have something to reference? i'm still not certain of what this task involves16:10
gitlab-br-botbuildstream: merge request (jjardon/misc_fixes->master: Some little documentation fixes) #326 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/32616:10
juergbitristan: do you have a quick comment on whether we have a policy against subclassing among mainline plugins (!305)? or is this a longer discussion?16:12
gitlab-br-botbuildstream: merge request (jjardon/misc_fixes->master: Some little documentation fixes) #326 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/32616:13
tristanjuergbi, commented16:17
juergbita16:17
tristanjuergbi, my reply might be premature, but I think it's quite fine inside mainline, and it's also fine within bst-external16:18
Nexusso i should make it a subclass?16:18
juergbii'd say so, yes. there is quite a bit of duplicated code right now16:18
tristanfor bst-external like package inter-subclassing, I may be wrong, or forgetting some detail16:18
tristanAh, it might not work, too16:19
tristanjuergbi, it might work for Source plugins but not Element plugins16:19
tristanbecause of the type-wide .yaml templates16:19
tristanso yeah, at least for this case, it should be fine16:19
juergbiok16:19
laurencejuergbi, Nexus, my notes from the f2f conversation in Jan tell me that Element Specific Build Directories and Cache Build Tree are blockers for 4 use cases we thought of: Workspace Open to contain build tree, Non-workspaced incremental builds, Source code available in environment in order to debug and finally UI for inspecting build logs and failed builds from the artifact cache16:21
gitlab-br-botbuildstream: merge request (jjardon/theme_change->master: Change theme to sphinx_rtd_theme) #327 changed state ("merged"): https://gitlab.com/BuildStream/buildstream/merge_requests/32716:21
laurenceMy point here being that I'd thought we were approaching Cache Build Tree as a stand alone thing and then other 4 things to come after it16:24
juergbilaurence: the issue is that it doesn't really make sense to merge something that is not actually used it16:24
juergbi*yet16:24
juergbiamong other things, you can't properly test it16:24
juergbithey are definitely separate commits / subtasks but at least one actual use case should be working with the MR16:25
Nexusso "Cache Build Tree" should actually be part of those 4 cases, not a blocker for them?16:25
Nexussince it's can't stand alone16:26
Nexusit16:26
juergbiit just shouldn't be merged stand-alone16:26
Nexuskk16:26
juergbiyou can develop it stand-alone but for testing and merging you need one of those 416:26
gitlab-br-botbuildstream: merge request (jjardon/misc_fixes->master: Some little documentation fixes) #326 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/32616:27
laurencealright, I see now, thanks juergbi, I shall get back in my cave and shut up :)16:27
Nexusof those 4, are there any currently fleshed out enough to be worked on?16:27
juergbii expect the 'open workspace' one to be the simplest, so would suggest to do that as the first of the 416:27
Nexuskk16:27
juergbiNexus: is the basic idea about opening the workspace with the cached build tree clear? details have to be worked out16:30
Nexusis this the same thing as "Workspace Open to contain build tree" ?16:31
juergbiyes16:31
NexusSo the basic idea being that, instead of opening a workspace with a new build, it pulls in the most recent cached build tree and uses that as its source instead?16:32
Nexusdo i have that right?16:32
gitlab-br-botbuildstream: merge request (jjardon/misc_fixes->master: Some little documentation fixes) #326 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/32616:33
gitlab-br-botbuildstream: merge request (jjardon/misc_fixes->master: Some little documentation fixes) #326 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/32616:46
*** Prince781 has quit IRC16:47
juergbiNexus: yes. at least for now we could restrict this to an exact cache key match to keep this simple16:49
juergbii.e., only do this if we already have an artifact (with build tree) for the current cache key of the element16:49
juergbiin the future we could also support it for older builds but that should likely be part of the effort to support incremental non-workspace builds16:50
Nexusjuergbi, tristan Do we want to make DebSource a subclass of TarSource? Wouldn't it be cleaner to make a base class for both?16:51
juergbithat would definitely also be a possibility16:51
juergbihowever, TarSource already has _get_tar() that can be overridden, so subclassing TarSource might work without changes there16:52
juergbii.e., I expect subclassing TarSource to be simpler and acceptable but I would also accept a new base class16:52
juergbiin that case, the refactoring (introducing new base class) should be a separate commit, though16:53
jjardon[m]tristan confirmed, https://buildstream.gitlab.io/buildstream/ works well in mobile :)16:53
Nexusis there a preference?16:53
gitlab-br-botbuildstream: merge request (jjardon/misc_fixes->master: Some little documentation fixes) #326 changed state ("merged"): https://gitlab.com/BuildStream/buildstream/merge_requests/32616:54
juergbiNexus: I would take the simpler route (directly subclassing TarSource) unless you have a reason not to. this isn't about public API, so it could also be refactored later if a need arises16:54
Nexuskk16:54
gitlab-br-botbuildstream: merge request (richardmaw/build-status-extensions->master: WIP: Print summary of failed builds) #329 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/32917:08
gitlab-br-botbuildstream: merge request (issue-243_dpkg_import_source_plugin->master: Created DPKG Source plugin for Issue #10) #305 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/30517:16
gitlab-br-botbuildstream: merge request (fix_typo_on_homepage->master: index.rst: Fixed typo in About BuildStream) #330 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/33017:18
gitlab-br-botbuildstream: merge request (fix_typo_on_homepage->master: index.rst: Fixed typo in About BuildStream) #330 changed state ("merged"): https://gitlab.com/BuildStream/buildstream/merge_requests/33017:19
*** Prince781 has joined #buildstream17:30
gitlab-br-botbuildstream: merge request (jjardon/getting_started->master: Add getting started section) #323 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/32318:00
*** jonathanmaw has quit IRC18:00
*** dominic has quit IRC18:01
gitlab-br-botbuildstream: merge request (jjardon/getting_started->master: Add getting started section) #323 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/32318:05
*** Prince781 has quit IRC18:19
*** slaf- has joined #buildstream18:27
*** slaf- has joined #buildstream18:27
*** slaf has quit IRC18:29
*** slaf- is now known as slaf18:29
gitlab-br-botbuildstream: merge request (jjardon/copyright->master: Some changes to the copyrigth / author lines) #331 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/33120:23
gitlab-br-botbuildstream: merge request (jjardon/copyright->master: Some changes to the copyrigth / author lines) #331 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/33120:24
gitlab-br-botbuildstream: merge request (jjardon/copyright->master: Some changes to the copyrigth / author lines) #331 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/33120:25
gitlab-br-botbuildstream: merge request (jjardon/contributing->master: Add HACKING document to official docs) #332 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/33220:26
gitlab-br-botbuildstream: merge request (jjardon/contributing->master: Add HACKING document to official docs) #332 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/33220:27
gitlab-br-botbuildstream: merge request (jjardon/copyright->master: Some changes to the copyrigth / author lines) #331 changed state ("opened"): https://gitlab.com/BuildStream/buildstream/merge_requests/33120:27
*** ernestask has quit IRC20:44
*** Prince781 has joined #buildstream20:50
*** sstriker has quit IRC21:00
*** tristan has quit IRC22:00
*** Prince781 has quit IRC22:11
*** Prince781 has joined #buildstream22:25
*** Prince781 has quit IRC22:36
*** valentind has quit IRC22:41
*** Prince781 has joined #buildstream22:48
*** aday has quit IRC22:59
*** Prince781 has quit IRC23:30

Generated by irclog2html.py 2.15.3 by Marius Gedminas - find it at mg.pov.lt!