Commit graph

15 commits

Author SHA1 Message Date
Kumar Gala 5fb312b784 doc: Update warning regex to handler newer sphinx output
Older versions of sphinx produced something like:

file_system/index.rst:58: WARNING: Duplicate declaration.

Newer versions produce:

file_system/index.rst:58: WARNING: Duplicate declaration, fs_statvfs

Change the regex to handle both conditions.

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2019-12-12 12:39:35 -06:00
Anas Nashif d6f72a67fc doc: introduce final structure
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>
2019-02-05 07:04:40 -05:00
Anas Nashif cb5ada94f8 doc: update known issues for new structure
Changed path for matching warnings.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-05 07:04:40 -05:00
David B. Kinder ae4d7612f0 doc: filter expected dup decl warnings
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>
2018-11-05 23:40:26 -05:00
Carles Cufi 5e5fe0d74f doc: known issues: Fix regexes for Windows
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>
2018-07-12 23:11:46 -04:00
Jukka Rissanen 99e93db6b2 net: stats: Add traffic class statistics
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>
2018-03-27 10:06:54 -04:00
Jukka Rissanen 81d8d5219c net: context: Add PRIORITY option support
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>
2018-03-27 10:06:54 -04:00
David B. Kinder 6360d762d6 doc: cleanup .known-issues filters
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>
2017-11-14 08:11:26 -05:00
Jukka Rissanen 2486694eb9 net: http: Create HTTP library that uses net-app
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>
2017-11-06 09:33:00 -05:00
Jukka Rissanen faccf55dd3 doc: Fix regexp in .known-issues networking.conf file
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>
2017-10-09 14:35:21 +03:00
Jukka Rissanen 539b0c46ff net: doc: Add missing defgroups to network header files
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>
2017-07-31 20:59:09 +03:00
Jukka Rissanen 611ccaaf88 net: dns: Remove dns_client API and sample application
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>
2017-04-13 15:21:45 +03:00
Tomasz Bursztyka 35e5aa8865 net/mgmt: Add a function to wait on a event synchronously
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>
2017-03-17 10:34:42 +02:00
Tomasz Bursztyka 12a0f71711 doc/api/networking: Add existing network protocol libraries APIs
DHCPv4, MQTT, DNS client, ...

Change-Id: I5c5d7437bb53610678eba38d307c86694ac01da9
Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2017-02-03 15:59:18 +02:00
Tomasz Bursztyka d8323e1a6c doc: Include main Network APIs doxygen documentation
Added missing dogygen definitions.

Jira: ZEP-1495

Change-Id: Ibc087f3f174b8af45b0726c0d82b77feff36d4e3
Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2017-02-03 15:59:17 +02:00