Commit Graph

7 Commits

Author SHA1 Message Date
Jukka Rissanen 622e49394a doc: net: Re-apply the networking release notes for 1.14
This is a revert of 45a4fbf2ae and
this commit removes the offending function references from
Networking chapter in 1.14 release note. After the BSD socket
documentation adds the function references we can revisit the
release note and add back the function references.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-03-15 10:35:46 -05:00
Kumar Gala 45a4fbf2ae Revert "doc: Add networking information to 1.14 release note"
This reverts commit fe9f85464c.

Getting the following issues:

releases/release-notes-1.14.rst:60: WARNING: 'any' reference target not found: getnameinfo
releases/release-notes-1.14.rst:60: WARNING: 'any' reference target not found: shutdown
releases/release-notes-1.14.rst:60: WARNING: 'any' reference target not found: freeaddrinfo
releases/release-notes-1.14.rst:60: WARNING: 'any' reference target not found: gethostname
releases/release-notes-1.14.rst:60: WARNING: 'any' reference target not found: getsockopt
releases/release-notes-1.14.rst:60: WARNING: 'any' reference target not found: setsockopt
releases/release-notes-1.14.rst:60: WARNING: 'any' reference target not found: select

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2019-03-15 08:02:15 -05:00
Jukka Rissanen fe9f85464c doc: Add networking information to 1.14 release note
Contains major networking changes between 1.13 and 1.14 releases.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-03-15 06:48:41 -05:00
David B. Kinder 6000a6205a doc: prepare for improving doc API linking
Linking to API material requires knowing the pecularities of how
doxygen, sphinx, and breathe work. In an attempt to hide some of this
we're preparing the current docs to allow use of configuration defaults
that will let us more simply use a default role that will hunt for a
reference target in the various domains that are available by using a
default "role" of "all".  This will let us use the simple notation
`functionname` or `typename` without fully specifying the reference as
:c:func:`functionname`.

This patch cleans up exising docs that were (incorrectly) using single
backtics where double backtics should have been used, and also found
some typos (such as a space between the role name and the reference,
such as :file: `filename`, and a missing colon such as
c:func:`functionname`)

This is a start to address issue #14313

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-03-15 05:47:19 +01:00
David B. Kinder 8164505aad doc: Release notes initial (empty) draft
Get things started for the 1.4 release notes.
Individual teams will update their appropriate sections.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-03-13 05:36:39 -05:00
Anas Nashif 2b9458c378 doc: restructure and create index pages
Move all lead pages to be index pages and create redirect rules from the
old pointers.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-05 07:04:40 -05:00
Anas Nashif 96140fa029 doc: move release notes to own folder
Remove release note noise into a new folder.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-05 07:04:40 -05:00