Skip to content

make all: document targets for RIOT base module#20187

Merged
benpicco merged 1 commit intoRIOT-OS:masterfrom
mguetschow:make-base-help
Dec 15, 2023
Merged

make all: document targets for RIOT base module#20187
benpicco merged 1 commit intoRIOT-OS:masterfrom
mguetschow:make-base-help

Conversation

@mguetschow
Copy link
Copy Markdown
Contributor

@mguetschow mguetschow commented Dec 15, 2023

Contribution description

There is no target similar to make help available when calling make from the RIOT base directory, although there are several useful targets that are supposed to be called from there. Instead of adding a new help target, this PR lists the available targets manually in the welcome message.

Testing procedure

With these changes, make or make all from the RIOT base directory gives:

Welcome to RIOT - The friendly OS for IoT!

You executed 'make' from the base directory.
Usually, you should run 'make' in your application's directory instead.

Please see our Quick Start Guide at:
    https://doc.riot-os.org/getting-started.html
You can ask questions or discuss with other users on our forum:
    https://forum.riot-os.org

Available targets for the RIOT base directory include:
 generate-{board,driver,example,module,pkg,test}
 info-{applications,boards,emulated-boards} info-applications-supported-boards
 print-versions
 clean distclean pkg-clean
 doc doc-{man,latex}

make: *** [Makefile:7: all] Error 1

@benpicco benpicco added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: build system Area: Build system labels Dec 15, 2023
benpicco
benpicco approved these changes Dec 15, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@benpicco benpicco left a comment

Choose a reason for hiding this comment

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

Nice idea, thank you!

@benpicco benpicco added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Dec 15, 2023
@riot-ci
Copy link
Copy Markdown

riot-ci commented Dec 15, 2023

Murdock results

✔️ PASSED

f33662a make all: document targets for RIOT base module

Success Failures Total Runtime
1 0 1 55s

Artifacts

@benpicco benpicco added this pull request to the merge queue Dec 15, 2023
Merged via the queue into RIOT-OS:master with commit 095ac74 Dec 15, 2023
@MrKevinWeiss MrKevinWeiss added this to the Release 2024.01 milestone Feb 7, 2024
@mguetschow mguetschow mentioned this pull request Oct 8, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@benpicco benpicco benpicco approved these changes

Assignees

No one assigned

Labels

Area: build system Area: Build system CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Milestone

Release 2024.01

Development

Successfully merging this pull request may close these issues.

4 participants

@mguetschow @riot-ci @benpicco @MrKevinWeiss