Skip to content

maintainability: properly document the build process #723

@cfriedt

Description

@cfriedt

Was "maintainability: do not check in generated code"

Currently, the version of gcc that is contained in the Zephyr SDK (https://github.com/zephyrproject-rtos/gcc) contains some generated code that is checked-in (e.g. ./configure scripts).

This requires an additional manual step of regenerating the ./configure script from configure.ac (and many other support files) via autoreconf that may or many not be easily reproducible (e.g. the default autoreconf in Ubuntu might not work, it might be necessary to get the latest from gnu).

It's generally bad to check generated code into version control and generally worse to require either manually patching the generated code or some specialized knowledge about how to do it.

The main issue is sustainability; rather than the build process being predictable and linear, it becomes unpredictable, non-linear, and not really stainable. Without having specialized tools or domain specific knowledge, or a particular build machine or version, it makes it difficult for developers to make successful PRs to the SDK.

So I would like to just request that we do not check in generated code (in the form of ./configure scripts and so on), and instead insert (or populate) a dedicated step in the build process to simply regenerate those scripts.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions