Move guides and APIs into separate directories and cleanup naming
introducing index files rather than named section files.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Create a reference page for each peripheral and move doxygen API
reference to the main documentation page.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Changes to uart.h in PR #10820 caused a new warning from Sphinx/Breathe
that we can classify as a "known issue" and should ignore.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
The API documentation for networking.rst can throw a doxygen warning
depending on the versions of sphinx/breathe being used.
Fixes: #11111
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Fix the regexes in the known issues database so that they work on
Winndows machines with different path formats.
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
New versions of Sphinx/Breathe are throwing a new warning that
we'll need to filter before upgrading to breathe 4.9.1 and sphinx 1.7.5
This change won't impact our current builds but will prevent new known
warning messages when we upgrade the doc build tools.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Add statistics for number of packets and bytes to each traffic
class. Print this information in net-shell.
Also make sure that we do not calculate total packet length many
times. So calculate network packet total length once and then use
that value instead of calculating it many times in a row.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
Add context option support and implement PRIORITY option that
can be used to classify the network traffic to different trafic
classes according to said priority value.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
Some API material (from doxygen comments) wasn't included in the
generated documentation because there was no doxygengroup Sphinx
directive to display them. This PR add content into appropriate places
in existing documentation (e.g., Bluetooth Cryptography APIs into the
Bluetooth API doc) and creates two new collections for Display and
Miscellaneous APIs.
Comments added to the .rst files to mention doxygengroups that are
intentionally excluded (because they're organizational groups containing
subgroups that are included).
Sorted the Bluetooth API list, mostly.
Fixed a couple doxygen group titles defined in the include files, and
added a few patterns to filter new "expected" errors from the document
generation process.
Legacy and deprecated APIs remain left out, as intended:
http_legacy (net/http_legacy.h)
spi_interface_legacy (spi_legacy.h)
zoap (net/zoap.h)
fixes: Issue #5051
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Sphinx/breathe doesn't support showing nested groups, so explicitly add
the nested groups in the API documentation (for Bluetooth Mesh).
Also, added an ignore pattern for a nested unnamed type known issue.
fixes: issue #5040
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Sphinx is configured to properly handle function attributes that were
causing many "expected" warnings. Remove filtering for these warnings
since they're not showing up any more. (Note that nested unnamed struct
and union declarations still are an "expected" issue.)
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Create http library that uses net-app instead of net_context
directly. The old HTTP API is deprecated.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
This fixes following error:
ERROR: zephyr/.known-issues/doc/networking.conf: bytes 622-1441:
bad regex: bad escape \I at position 119 (line 2, column 2)
ERROR: E: zephyr/.known-issues/doc/networking.conf: can't load
config file: bad escape \I at position 119 (line 2, column 2)
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
Some of the networking header files in include/net/ directory were
missing @defgroup doxygen directives.
There was also duplicate @defgroup directives which are now changed
to @addtogroup directives.
Added also missing API links to doc/api/networking.rst file.
Added exceptions to .known-issues/doc/networking.conf file so that
doxygen does not complain.
Jira: ZEP-2308
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
DNS resolving is better done with DNS resolve API so remove
the DNS client API which is quite hard to use.
Change-Id: Ide4973a5be674414ea6e04a35c938195cce40b6a
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
Instead of creating a handler and a related callback structure on an
event_mask: net_mgmt_event_wait() can be used to wait synchronously on
such event_mask. The core mgmt part will seamlessly reuse the struct
net_mgmt_event_callback so the whole internal notification mechanism is
using the same code.
Change-Id: I426d782c770e75e5222aa3c5b703172b1f1f2e5e
Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
This will allow inclusion of documentation files that exist outside of
doc/ and will make it possible to add rst files across the tree,
especially for boards, samples and tests.
Change-Id: I7afcf92d99f504b2bc0b2b7e3452acb2f8e08294
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
TCF now prints more detail in the summary line to conform with the
rest of the lines to ease up parsing; update said line to filter it
properly.
Change-Id: I7c21eea18a67dbfd027d680036762546556f90db
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Updated SKIP line to use whitespace and non-whitespace.
Change-Id: Ia1b2823836cf96f4065b39dca49c660601e1ea88
Signed-off-by: Javier B Perez <javier.b.perez.hernandez@intel.com>
The regular expression we use to catch the summary messages was not
generic enough to catch it. This causes it to not be classified as a
known issue to ignore and shows up in the output of
filter-known-issues, when it should not.
Fix the regex to be more generic.
Change-Id: I3e53d061325c90c861799dabc1f548177c650bc3
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Some regular expressions used to ignore outputs could use some extra
documentation to clarify what was being ignored.
Change-Id: Iabf3ce6964a89cdb7f9bbe8d99a3b4b8f98da59b
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
No need to ignore these issues any more.
Change-Id: I943f12753b7b80e50b1006146d3c7d4b4137584e
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Added new config file to filter the known issues for arduino 101
and quark_se_c1000.
Added filter for known TCF issues like SKIP and BLCK lines
Change-Id: Ie77b0cee2c395b8ea4f6d832023c7207d922c108
Signed-off-by: Javier B Perez <javier.b.perez.hernandez@intel.com>
Update whitelist to filter out unnamed structure warning
while building documentation.
Change-Id: I7f983bc125589800c5118a745ebf7b6849f44833
Signed-off-by: Mariusz Skamra <mariusz.skamra@tieto.com>
This is is a proposal to have a system to filter the output of the
build (compilation, documentation, sanity check and runtime tests)
that eliminates known issues so that whoever sees the output of the
tree can note new issues being added without having to dive on
existing, known ones.
Most common user of this will be the continuous integration system, to
decide what is shown to gerrit as feedback to the user who submitted a
change.
The rationale behind having it in the tree is that if somebody submits
code that introduces a false positive (due to tool limitations) or as
an accepted (normally minor) issue to be fixed later, it can also
submit a "filter" for it without breaking CI.
For example, consider the documentation workaround in include/uart.h
(that will be reverted when this is done):
diff --git a/include/uart.h b/include/uart.h
index a30b211..178bd5e 100644
--- a/include/uart.h
+++ b/include/uart.h
@@ -97,7 +97,7 @@ typedef void (*uart_irq_config_func_t)(struct device *port);
* @param sys_clk_freq System clock frequency in Hz
*/
struct uart_device_config {
- union __unnamed_workaround__ {
+ union {
uint32_t port;
uint8_t *base;
uint32_t regs;
This introduces a harmless warning in the documentation compilation
process due to a limitation in the tools that will be fixed in future
releases. In the meantime, as they accumulate, it makes more difficult
for people to know if *they* introduced any other warnings (or
errors). The configuration in .known-issues/doc/uart.conf matches that
warning and filters it out (and only that), with enough regex glue to work
around subtle context changes (like line numbers).
The implementation is a Python script that can take the build output
and remove what is being told to ignore by a list of configuration
files, each of which contains a list of single/multiline Python
regular expressions.
Addition of said exceptions is caught by CI: it will trigger a
maintainer being included as a reviewer because the as directed by the
entry for the .known-issues in the MAINTAINERS file.
Change-Id: I7939e0726f2c505481592c3a7f5f40fa3e9c62fd
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Anas Nashif