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.

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

doc/getting-started: point out where to run make #20336

Merged
merged 2 commits into from
Feb 5, 2024

Conversation

maribu
Copy link
Member

@maribu maribu commented Feb 4, 2024

Contribution description

This improves documentation at two locations:

  1. The getting started section previously never stated that make is supposed to be run in an applications folder
  2. The help message when make in the root directory got a tl'dr section at the end

Testing procedure

  1. The CI will add a link to the doc
  2. Run make in the root directory of the repo. The output should be:
make
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}

==> tl;dr Try running:
    cd examples/default
    make BOARD=<INSERT_BOARD_NAME>

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

Issues/PRs references

Fixes #20322 (comment)

When running `make` in the root directory, it might be best to just
add as tl;dr section at the bottom.
@github-actions github-actions bot added the Area: doc Area: Documentation label Feb 4, 2024
@maribu maribu added Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors) Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer 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 Area: doc Area: Documentation and removed Area: doc Area: Documentation labels Feb 4, 2024
@maribu
Copy link
Member Author

maribu commented Feb 4, 2024

@MrKevinWeiss Do you want a backport? I think the chances of breaking stuff are pretty low with this one :)

@riot-ci
Copy link

riot-ci commented Feb 4, 2024

Murdock results

✔️ PASSED

8ea106c build system: add tl;dr to error message

Success Failures Total Runtime
1 0 1 54s

Artifacts

@benpicco benpicco requested a review from Teufelchen1 February 4, 2024 19:03
@benpicco
Copy link
Contributor

benpicco commented Feb 4, 2024

Only minor changes indeed, nothing controversial.

@maribu maribu changed the title Doc/doxygen/src/getting started.md doc/getting-started: point out where to run make Feb 4, 2024
@benpicco benpicco added this pull request to the merge queue Feb 4, 2024
@benpicco benpicco removed this pull request from the merge queue due to a manual request Feb 4, 2024
@benpicco benpicco added this pull request to the merge queue Feb 4, 2024
Merged via the queue into RIOT-OS:master with commit e83ab21 Feb 5, 2024
32 checks passed
@MrKevinWeiss
Copy link
Contributor

@MrKevinWeiss Do you want a backport? I think the chances of breaking stuff are pretty low with this one :)

It is nice but I don't think critical for this release.

@maribu maribu deleted the doc/doxygen/src/getting-started.md branch February 6, 2024 10:25
@MrKevinWeiss MrKevinWeiss added this to the Release 2024.04 milestone Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation 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 Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

msp430: DWARF line info data is bigger than the space remaining in the section
4 participants