> >> Possible compromise: have this info live in the tree as part of the > >> in-tree docs under build/docs. You need build peer review to update > >> those docs and they are versioned with the tree. That addresses my > >> accuracy and versioning concerns. > > > > This sounds reasonable to me! The docs would always be up to date with the > > code being built, anyone experiencing an issue can look it up in a known > > location, anyone with knowledge about a particular issue can update the > > doc, and build peers don't have to spend their time keeping config rules > > constantly up to date! Assuming people are on board with this plan, how > > would we go about starting that doc? > > b76171a0d6ec and newer (currently inbound only) have a > build/docs/supported-configurations.rst file documenting supported build > configurations. I just filled it in with basics. > > Feel free to make obvious updates with "NO BUG" "DONTBUILD (NPOTB)" and > no build peer review. Please at least get a pastebin/irc "review" from a > build peer for anything too involved. > > If people have time to write patches to configure to enforce missing > requirements, we'll happily review them.
The doc looks great! To further solve the issue of "my build broke and I'm not sure what config-option caused it or how to fix my build," we could add a section like the following to the doc: ################################ Known Issues ======================== This section documents known issues that cause builds to fail. Bug ID: 808932 Affected configs: Building B2G with --disable-optimize and --disable-jemalloc Workarounds: Bug ID: 899948 Affected configs: Building FX on VS(any) with --disable-optimize but not --enable-debug Workarounds: --without-intl-api Don't see your issue here? Try here - <bugzilla query or wiki link or here> ################################ I'm not in love with the format - it seems like the list will not be very readable if there are 20+ or so items in it - maybe we could split the list up by platform or something? I'm also happy to just use this as a starting point and modify the format if/when it becomes an issue. _______________________________________________ dev-platform mailing list dev-platform@lists.mozilla.org https://lists.mozilla.org/listinfo/dev-platform
