Michał Łyszczek
a5bcb2dc46
Documentation: fix multiple errors and warnings
...
Multiple files were badly formatted, which resulted in many
warnings. This made it harder to check for errors in newly
written documentation.
What's worse, badly formatted text resulted in butchered
output in generated html.
This patch fixes most of the errors, but alas, not all of
the errors can be fixed. Anyway, this should be way easier
to spot errors in newly written docs now.
Signed-off-by: Michał Łyszczek <michal.lyszczek@bofc.pl>
2022-06-08 03:02:32 +08:00
Xiang Xiao
1d1bdd85a3
Remove the double blank line from source files
...
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2022-02-20 20:10:14 +01:00
Xiang Xiao
5025fbef8d
Rename LIB_ to LIBC_ for all libc Kconfig
...
follow other libc component naming convention
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2021-08-05 19:45:24 +02:00
Nathan Hartman
935c206bd4
Documentation: Fix typos
...
Documentation/reference/os/wqueue.rst:
* Fix spelling, grammar, and typos.
* Improve wording in a few areas.
* Re-wrap the paragraphs that were modified.
2021-07-05 23:08:21 -05:00
chao.an
ebf89ff63b
mm/iob: add iob_get_queue_size() helper
...
Signed-off-by: chao.an <anchao@xiaomi.com>
2021-07-05 06:20:52 -05:00
Nathan Hartman
a8cbcd084f
signal: Fix docs and comments related to SIGWORK and its config
...
Documentation/reference/os/wqueue.rst:
* CONFIG_SIG_SIGWORK: Fix sentence that was cut off in the
middle.
include/signal.h:
* SIGWORK: Fix grammar in comment.
sched/Kconfig:
* config SIG_SIGWORK: Fix ---help--- text to indicate that
this user-configured signal number may be used by various
internal worker threads.
2021-06-30 21:22:49 -05:00
chao.an
2c51c29768
mm/iob: add an interface to support dequeue an iob from the queue
...
Signed-off-by: chao.an <anchao@xiaomi.com>
2021-06-10 10:45:30 -05:00
chao.an
e73883aba5
Documentation/iob: update the function prototype
...
Signed-off-by: chao.an <anchao@xiaomi.com>
2021-06-10 10:45:30 -05:00
Nathan Hartman
26f09cec6d
Documentation: Fix a few typos.
...
* Documentation/contributing/documentation.rst
* Documentation/guides/tasktraceuser.rst
* Documentation/guides/drivers.rst
* Documentation/quickstart/running.rst
* Documentation/quickstart/compiling.rst
* Documentation/components/drivers/character/watchdog.rst
* Documentation/components/drivers/character/foc.rst
* Documentation/components/nxgraphics/nxtk.rst
* Documentation/applications/nsh/login.rst
* Documentation/introduction/detailed_support.rst
* Documentation/introduction/resources.rst
* Documentation/reference/user/01_task_control.rst
* Documentation/reference/os/wqueue.rst
Fix some misspelled words.
Many of these were caught by codespell.
2021-04-28 17:00:23 -03:00
Nathan Hartman
4a75b41b4d
Documentation: Minor fixes
...
Documentation/guides/drivers.rst:
* Replace wrong "Ethernet" with "SD Card"
Documentation/platforms/arm/imxrt/index.rst:
* Fix misspelled "Supported"
Documentation/platforms/xtensa/esp32/index.rst:
* Fix doubled "also"
* Fix "the" -> "to"
Documentation/reference/os/index.rst:
* Fix doubled "also"
* Fix "also" -> "are"
2021-04-20 21:31:18 -05:00
Xiang Xiao
2335b69120
arch: Allocate the space from the beginning in up_stack_frame
...
arch: Allocate the space from the beginning in up_stack_frame
and modify the affected portion:
1.Correct the stack dump and check
2.Allocate tls_info_s by up_stack_frame too
3.Move the stack fork allocation from arch to sched
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2021-04-16 12:41:41 +09:00
Matias N
75b13c8353
documentation: improve boardctl() docs
2021-03-25 19:03:49 -03:00
Brennan Ashton
23cd1e030e
Docs: Fix broken links and references in docs
...
Also add to the CI a problem matcher to better report issues
Signed-off-by: Brennan Ashton <bashton@brennanashton.com>
2020-10-22 10:22:11 -03:00
Xiang Xiao
302d4da341
Documentation: Move note.rst to components/drivers/character/
...
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:45:05 -07:00
Xiang Xiao
598e3eedb4
Documentation: Remove all tail spaces from *.rst and *.html
...
by the below command:
find . -type f -name '*.rst' -exec sed --in-place 's/[[:space:]]\+$//' {} \+
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 10:51:22 -07:00
Nakamura, Yuuichi
1472a913a9
Add documentation for note filters and task trace guides
2020-10-16 10:13:15 +08:00
Matias N
9b08cf945f
documentation: address various duplicate declarations
2020-09-02 16:00:08 +08:00
Brennan Ashton
4cb193d530
Docs: Update links to old website and wiki
...
Signed-off-by: Brennan Ashton <bashton@brennanashton.com>
2020-08-30 19:16:30 -03:00
Matias N
6bcbbc3b28
backport watchdog API changes to new documentation (PRs: #1534 #1545 and #1565 )
2020-08-24 10:29:55 -07:00
Matias N
4276d6254a
rename doc/ -> Documentation/
2020-08-24 10:29:55 -07:00