Commit graph

8 commits

Author SHA1 Message Date
Pisit Sawangvonganan
eead5104fc doc: fix typo in multiple directories before v3.7.0 release
Utilize a code spell-checking tool to scan for and correct spelling errors
in various files within the `doc` directory.

Signed-off-by: Pisit Sawangvonganan <pisit@ndrsolution.com>
2024-07-08 09:21:24 +02:00
Andrej Butok
c8f12c9273 doc: kconfig: fix HAS_CONFIGURABLE_FOO
Use HAS_CONFIGURABLE_FOO instead of wrong HAS_CONFIGURABLE.

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2024-04-29 15:53:34 +02:00
Benedikt Schmidt
004b307206 doc: kconfig: add exemption for busses in select recommended practices
Add the exemption for busses to the recommended practices
for select.

Signed-off-by: Benedikt Schmidt <benedikt.schmidt@embedded-solutions.at>
2024-02-26 12:06:06 +01:00
Benjamin Cabé
1be457f280 doc: kconfig: Add syntax highlighting for Kconfig snippets
Add proper pygments settings to make Kconfig snippets look pretty.
Also fixed a few config and devicetree code blocks.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-10-18 13:15:51 +03:00
Benjamin Cabé
59e4c5aed0 samples: fully migrate basic samples to the new Sphinx extension
- Updated basic samples READMEs to use the new zephyr:code-sample::
  directive. Dropped "-sample" suffix that's not required anymore now
  that samples have their own namespace.
- Updated all references to the samples to use the :zephyr:code-sample:
  role. Checked and updated the wording of said references to account
  for the fact that samples should not have "... sample" in their name
  anymore.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-09-13 09:15:34 +02:00
Torsten Rasmussen
c8942afe6d doc: add commas in macro arguments to Kconfig tips
Kconfig uses commas to separate macro arguments.

Improve Kconfig documentation by describing to users how this can be
handled when using devicetree Kconfig macros when using devicetree names
which may have commas in them.

Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-11-22 14:55:10 -08:00
Rubin Gerritsen
cc9d9ee0e3 doc: kconfig: Clarify note describing overriding default n
The phrasing "default y that comes on a later definition" was a bit
confusing to me. Clarified it by adding some examples.

Signed-off-by: Rubin Gerritsen <rubin.gerritsen@nordicsemi.no>
2022-08-15 08:18:46 +00:00
Anas Nashif
5c88418428 doc: build: move build docs one level up
This is now a top level section.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 16:35:19 +02:00
Renamed from doc/guides/build/kconfig/tips.rst (Browse further)