Commit Graph

24 Commits

Author SHA1 Message Date
Marc Herbert a64436c1e7 doc/CMakeLists.txt: build by default
Add missing `ALL` keyword so a bare `make` or `ninja` without any
argument runs doxygen by default instead of doing nothing at all. There
is a single target so really no reason not to build it. It's not
required anymore to know the secret word `make doc`.

Note this CMakeLists.txt is not included by any other CMakeLists.txt

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2022-07-19 09:38:30 +01:00
Curtis Malainey a0acad3414 CMake: require version 3.13
Without CMP0079 we cannot conditionally include libraries against SOF in
sub directories without seriously restructuring the project. This is
because the old policy requires the link target must be created in the
same folder. This does not work well from a configuration standpoint for
3P audio libraries trying to keep their config in src/audio/*. Rather
than enable the policy, lets simply upgrade since 3.13 is widely
available.

With this upgrade we can also remove the two version dependent checks at
the top of our scripts.

Signed-off-by: Curtis Malainey <cujomalainey@chromium.org>
2021-09-10 17:19:29 +01:00
Marc Herbert 3f4da1f1bb sof.doxygen.in: add CONFIG_TRACE=1
Stop ignoring most comments in the trace.h file.

Confusingly, only comments in trace.c were considered because unlike
trace.h, trace.c is not turned off by the preprocessor but by CMake
instead.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2021-07-21 09:17:05 +01:00
Liam R Girdwood fa639cf307 doxygen: codecs: exclude 3rd party codec headers from Doxygen
Lets try and keep 3rd party codec headers as-is without any modifications.
This include doxygen as some references may be in closed headers.

Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
2021-04-10 21:53:32 +01:00
Marc Herbert e163bf1513 sof.doxygen.in: change ../test to @top_srcdir@/test
Makes it possible to place the build directory anywhere.

This directory does not seem in use any more; fixing it does not change
the doxygen output. However this does silence a doxygen error message
when the build directory is not in the usual place.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2021-01-27 11:00:04 +00:00
Marcin Maka eee6a252a5 audio-stream: dox: add full api documentation
Audio stream is an important piece used by components
therefore full documentation is required by component
developers to operate on source and sink buffers
attached ot their components.

Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2020-03-28 13:04:55 +01:00
Janusz Jankowski 8eb6a7861d testbench: move README from doc to tools
All tools-related programs should be in tools README.

Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2019-06-12 12:19:45 +02:00
Janusz Jankowski 730f051d67 doc: remove duplicated README for host
Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2019-06-12 12:19:45 +02:00
Janusz Jankowski c6064624f6 cmake: add spdx license identifier
Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2019-06-02 16:38:17 +01:00
Janusz Jankowski e39ed5ebf4 include: split uapi headers into more directories
Some of interface headers are not needed by kernel,
but are needed by user-space applications, so we can split them
into multiple directories that indicate their purpose.

Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2019-05-31 20:10:45 +01:00
Marcin Maka 8169a9ec07 dox: reformatted documentation for component and ipc control
Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2019-02-04 12:42:03 +00:00
Janusz Jankowski 85457b0c16 cmake: doc: specify no languages
Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2019-01-25 15:55:39 +00:00
Janusz Jankowski d91be6da67 buildsystem: remove autotools from sof
This commit doesn't touch tools buildsystem.

Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2019-01-22 15:35:35 +00:00
Janusz Jankowski 07bd1b20cb cmake: add doc CMakeLists
Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2019-01-22 15:35:35 +00:00
Liam Girdwood dc6014f226 Merge remote-tracking branch 'gh/next' into gp20-alpha-drop-stable 2018-08-16 15:52:03 +01:00
Janusz Jankowski e291d5da49 doc: remove README.rst, it's in sof-docs now
Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2018-07-11 17:55:44 +02:00
Marcin Maka 2fa1119c7a doc: doxygen and breathe warnings neutralized
- There is too much undocumented code, so warn about syntax errors
  in the existing dox only.
- Breathe does not understand __attribute__, so preproc this out.

Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2018-07-03 11:23:53 +02:00
Marcin Maka 88c12a1f52 doc: renamed doxygen output dir to doxygen
Integration with sof-docs and breathe does not require
to split the output. So write to a single one and refer
later by doxygen groups.

Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2018-07-03 11:23:52 +02:00
Tomasz Lauda 14ca1fa3d5 pm_runtime: add runtime power management initial implementation
This patch adds initial empty implementation of runtime power management.
It is based on linux kernel implementation and will be developed
in the future.

Signed-off-by: Tomasz Lauda <tomasz.lauda@linux.intel.com>
2018-06-20 15:18:09 +02:00
Janusz Jankowski d6d9efb90c test: enable cmocka unit tests for SOF
Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2018-06-11 20:11:32 +01:00
Ranjani Sridharan c8bc724ad9 doc: add README for host testbench
Signed-off-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
2018-06-01 08:28:16 +01:00
Ranjani Sridharan 48c52ee5eb scripts: add script for building host library and invoking the testbench
Signed-off-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
2018-06-01 08:28:16 +01:00
Zhang Keqiao 9a33490ce0 dist: fix make dist compiling issue
Signed-off-by: Zhang Keqiao <keqiao.zhang@linux.intel.com>
2018-04-24 08:09:43 -07:00
Marcin Maka 6aee21bb42 Makefile support for doc target.
Builds uapi documentation in html format using doxygen.
See doc/sof_uapi/html/index.html
First dox samples in the source code provided by the patch.

Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2018-04-13 14:56:04 +01:00