Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

more details about build configs #344

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

more details about build configs #344

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/Developer-Guide_Build-Preparation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,10 @@ Make sure that full path to the build script **does not contain spaces**.

## Providing build configuration

After the first run of `compile.sh` a new configuration file `config-example.conf` and symlink `config-default.conf` will be created.
You may edit it to your needs or create different configuration files using it as a template.
After the first run of `compile.sh` a new configuration file `config-example.conf` and symlink `config-default.conf` will be created in `userpatches`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not real. No examples, symlinks, or anything like should be created by the build system, and if they are, it's a bug.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was MO with old system, so this info is deprecated.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just ever saw it cos the PR touched it ;-)

You may edit it to your needs or create different configuration files using it as a template. To start a build with a specific configuration file, e.g. for `config-foo.conf`:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Configurations are supported but one needs to make it on their own. Its just a collection of parameters.

This should be reworked, previous statement removed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A configuration file named userpatches/config-<something>.conf.sh (.conf also allowed) is a bash script that is sourced during the build if you use ./compile.sh something. You can use it to pass the parameters you'd normally pass on the command line (PARAM1=value1 PARAM2=value) by using the same syntax, but put each PARAM on a separate line. Command-line parameters still are able to override what is the config file. More advanced use cases can use conditionals, define functions to implement hooks, source other/common config files, etc. A few quite complex examples can be found in https://github.com/lanefu/armbian-userpatches-example-indiedroid-nova

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have been quite confused by this issue. I saw many older comments about config-default.conf being made but when I ran build (current main branch of armbian/build) it wasn't made. I spent a lot of time trying to figure out what I was doing wrong - why it wasn't made. Finally I found the 'Developer Guide - Welcome' page which explained the behaviour has changed, but this page isn't linked from the documentation site. I found it in some search - now I don't recall. Anyway, I think it would be a good thing in the documentation to describe the old behaviour and the new behaviour and when it changed so that the many older posts and comments about the config files are less confusing.


./compile.sh foo

Alternatively you can supply options as command line parameters to compile.sh.
Example:
Expand Down