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: searches for sys_reboot() are inconsistant #42102

Closed
pearson opened this issue Jan 24, 2022 · 6 comments
Closed

doc: searches for sys_reboot() are inconsistant #42102

pearson opened this issue Jan 24, 2022 · 6 comments
Assignees
Labels
area: Documentation bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug Stale

Comments

@pearson
Copy link
Contributor

pearson commented Jan 24, 2022

It is difficult to find documentation on sys_reboot() and associated symbols. Searching through the main Zephyr documentation site gives different search results from a search starting from the Zephyr API Documentation Files List.

Searching through the Zephyr documentation site:

  • searching for sys_reboot() only lists a couple mentions of the function, as well as CONFIG_REBOOT, but no documentation on the function itself
  • searching for SYS_REBOOT_WARM gives no results
  • searching for SYS_REBOOT_COLD lists one result of the define in use, but no description of it

Searching from [File List](https://docs.zephyrproject.org/latest/doxygen/html/files.html) or other pages in the File List tree:

  • typing sys_reboot(), SYS_REBOOT_WARM, or SYS_REBOOT_COLD into the search box shows a drop-down menu with a link to reboot.h File Reference. This page does show some minimal documentation for sys_reboot().

My expectation would be to find search results for sys_reboot() when doing so from the main Zephyr documentation page.

@pearson pearson added the bug The issue is a bug, or the PR is fixing a bug label Jan 24, 2022
@dkalowsk dkalowsk added area: Documentation priority: low Low impact/importance bug labels Jan 25, 2022
@manoj153
Copy link
Contributor

Concur, I do not know WARM vs COLD.

@github-actions
Copy link

This issue has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this issue will automatically be closed in 14 days. Note, that you can always re-open a closed issue at any time.

@owain-incus
Copy link

Kind of a pretty basic functionality one would want to use.
Should be documented.

@bandogora
Copy link

Bumping this because I'm looking for documentation right now.

@kartben
Copy link
Collaborator

kartben commented May 16, 2023

Related to issue #55173.

@kartben
Copy link
Collaborator

kartben commented Jul 31, 2023

This will be fixed with #60920, courtesy of @gmarull ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Documentation bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug Stale
Projects
None yet
Development

No branches or pull requests

7 participants