1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Commit Graph

235 Commits

Author SHA1 Message Date
Akshai M
879263c1d2 doc/kconfig.md : Added Appendix D
Added a new section, Appendix D, to describe a few key aspects
while exposing a macro to Kconfig.

Co-authored-by: Leandro Lanzieri <leandro.lanzieri@haw-hamburg.de>
2020-06-03 20:04:38 +05:30
0b778fec46
doc/porting-boards: add section about board generator 2020-05-20 19:05:40 +02:00
bdf4efa9bb
doc/creating-application: add section about example/test generator 2020-05-20 19:05:40 +02:00
f4ea2b97c8
doc/creating-modules: add section about module generator 2020-05-20 19:05:40 +02:00
26d3bc3b42
doc/driver-guide: add section about driver generator 2020-05-20 19:05:40 +02:00
53ea5ff883
doc/build-system-basics: fix typo 2020-05-08 11:29:39 +02:00
Chamaeleon-
f76b88177c
doc/doxygen: enable svg output
changed DOT_IMAGE_FORMAT to svg to get searchable dependency and call graphs
2020-04-30 12:55:31 +02:00
Francisco
919249f361
Merge pull request #13862 from maribu/extra_boards
Makefile*: Allow multiple external board dirs
2020-04-29 20:12:06 +02:00
Marian Buschsieweke
ba7815163c
Makefile*: Allow multiple external board dirs
- Add the new EXTERNAL_BOARD_DIRS variable that can contain a space separated
  list of folders containing external boards
- Introduce $(BOARDDIR) as shortcut for $(BOARDSDIR)/$(BOARD)
- Map the existing BOARDSDIR to the new approach
    - If BOARDSDIR is provided by the user, it will be added to
      EXTERNAL_BOARD_DIRS for backward compatibility. (And a warning is issued
      to encourage users migrating to EXTRA_BOARDS.)
    - BOARDSDIR is updated after the board is found to "$(BOARDDIR)/..".
        - Useful for `include $(BOARDSDIR)/common/external_common/Makefile.dep`
        - Provides backward compatibility
2020-04-29 18:32:39 +02:00
Francisco Molina
67910a1219
doc/creating-modules.md: correct PSEUDOMODULES documentation 2020-04-21 09:25:06 +02:00
Marian Buschsieweke
3628db19fd
Makefile.features: Allow "one out of" dependencies
An application/test/module that requires one feature out of a set of
alternatives (let's say either periph_uart, periph_spi, or periph_i2c) can
request this now using:

    FEATURES_REQUIRED_ANY += periph_uart|periph_spi|periph_i2c
2020-04-01 09:12:50 +02:00
Gunar Schorcht
2d0ee5ca67 doc/porting-boards: fix broken links 2020-03-24 10:38:40 +01:00
8069c8e5a1
doxygen: increase DOT_GRAPH_MAX_NODES 2020-03-03 14:09:37 +01:00
Jan Mohr
67569fbd56 doc/creating-modules: updated Pseudomodules entry 2020-02-28 16:51:53 +01:00
ab9c67e621
Merge pull request #13257 from fjmolinas/pr_creating_boards_md
doc/doxygen: add creating boards doc
2020-02-12 08:40:53 +01:00
Francisco Molina
a348f1db48
doc/doxygen: add creating boards doc 2020-02-11 16:50:50 +01:00
Leandro Lanzieri
efea82eb7a doc: Add section on configuration in 'getting started' page 2020-02-05 15:51:55 +01:00
Leandro Lanzieri
3416205de0 doc: Move Kconfig next to build system section 2020-02-05 13:32:12 +01:00
Leandro Lanzieri
ab3cea197f doc: Add Kconfig documentation section
This adds information regarding the usage of Kconfig from an user
perspective and in-depth information on how Kconfig is currently
integrated to RIOT's build system.
2020-01-17 09:49:38 +01:00
784920b755
Merge pull request #12473 from fjmolinas/pr_board_cpu_features_doc
doc/doxygen: add build system doc page for BOARD, CPU, FEATURE
2020-01-15 17:35:37 +01:00
Francisco Molina
963ec794d2 doc/doxygen: add build system doc page for BOARD, CPU, FEATURE 2020-01-15 15:53:03 +01:00
fc28ac2a58
Merge pull request #12573 from fjmolinas/pr_doc_udev_rules
doc/advanced-build-system-tricks: handle multiple boards
2020-01-15 07:05:44 +01:00
Francisco Molina
4770b3c36b doc/advanced-build-system-tricks: handle multiple boards 2020-01-14 15:48:33 +01:00
Marian Buschsieweke
3cff7c022e
doc: Update CSS for readable @retval tables
Currently now margin between the return value and its description are added in
return value tables generated with the @retval command. This adds a 2em margin,
which is consistent with the margin after parameter names in the parameter
table.
2020-01-08 15:20:08 +01:00
Francisco
f6f4469542
Merge pull request #11889 from miri64/tapsetup/enh/sudo
tapsetup: require to be executed with sudo
2020-01-04 10:43:06 +01:00
Martine S. Lenders
38f76f951d doc: adapt doc on tapsetup for new sudo requirement 2020-01-03 21:00:54 +01:00
Jue
bc46c7478f drivers: add Differentially Operated Serial Ethernet driver 2019-12-16 10:43:13 +01:00
jasdeepgill
75770b5641
doc: minor text fix for mainpage.md
Rearranged sentence so that only one 'and' is used in the sentence
2019-11-30 14:49:55 +01:00
Benjamin Valentin
97d8e9fec1 doc/driver-guide.md: fix typo 2019-11-28 19:33:35 +01:00
Benjamin Valentin
a8b540adcf doc/driver-guide.md: add a note about float
floating point variables should generally be avoided.
2019-11-28 19:11:33 +01:00
c68470fc3d
Merge pull request #12783 from maribu/driver_guide
doc: move device driver guide to a doxygen page
2019-11-28 19:00:27 +01:00
Marian Buschsieweke
7108394172
doc/driver-guide.md: Doxygen integration
- Added the file to `riot.doxyfile`
- Shortened the header to display properly
- Added `[TOC]` to let doxygen create a table of contents
- Added manual anchors to the headers for consistency with other doc files
- Use @code and @endcode for code blocks (using fenced blocks doesn't parse
  with the Doxygen version used by the CI)
- Changed a numbered list containing code blocks to regular text, as the code
  blocks as list items are not parsed correctly
2019-11-28 13:58:26 +01:00
Marian Buschsieweke
267253dc5c
doc/driver-guide.md: Applied coding convention
- Enforce 80 chars per line limit
- Fixed some typos
- Removed trailing whitespace
- Added markdown syntax for code highlight in two cases
- Reduced the TODO section heading from level 1 to level 2

==> No content changes
2019-11-28 13:57:47 +01:00
Francisco Molina
5212e86226 doc/doxygen: add build-system-basics.md 2019-11-27 17:32:03 +01:00
Marian Buschsieweke
86ba1043a2
Added driver guide verbatim
Copied the contents of a680cbf442
as doc/doxygen/src/driver-guide.md without any modifications
2019-11-25 10:11:35 +01:00
889dba2aed doc: fix typos 2019-11-23 22:39:38 +01:00
Francois Berder
4a31f94cfc many typo fixes
Signed-off-by: Francois Berder <18538310+francois-berder@users.noreply.github.com>
2019-11-23 22:39:07 +01:00
Benjamin Valentin
0ea2cbf1eb boards: remove RTT_NUMOF/RTC_NUMOF
Those macros are defined but never used.
2019-11-08 14:20:33 +01:00
Martine S. Lenders
0a2945164c lwip: improve and fix documentation 2019-10-09 14:45:30 +02:00
Ken Bannister
3e0a3b1746
Merge pull request #12389 from miri64/pkg/depr/emb6
emb6: deprecate package
2019-10-09 06:53:50 -04:00
Martine S. Lenders
0d8511616a emb6: fix documentation 2019-10-09 11:27:52 +02:00
Francisco
1c5c027ee7
Merge pull request #12004 from cladmi/pr/make/dependencies/debug_targets
make: add targets to debug dependencies variables
2019-10-08 17:41:34 +02:00
Gaëtan Harter
9940a15bcc
doc: add documentation on dependency debug targets
Add short documentation for the dependency resolution debug targets.
Point to the main files for more infos.
2019-10-08 11:26:29 +02:00
Marian Buschsieweke
6bf5dd2963
doc/doxygen: Use python3 in generate-changelog.py 2019-09-10 10:10:12 +02:00
MrKevinWeiss
7bd633a8b2 tests/doc: Add intial how to test doc
This commit adds a README.md to the testing folder.
It explains the basic about how to run a test with testrunner.
It adds a reference so it will be displayed on the doxygen docs.
There currently is not obvious documentation for running tests.
2019-03-24 15:15:35 +01:00
Juan I Carrano
6c7984e52d
Merge pull request #11037 from cladmi/pr/doc/remove_lesscpy
doc/doxygen: remove support for lesscpy
2019-03-06 15:25:11 +01:00
Gaëtan Harter
944d0f31af
doc/doxygen: add package name for lessc
Add package name in ubuntu for lessc.
2019-02-20 11:35:06 +01:00
Gaëtan Harter
37349a0b19
doc/doxygen: remove support for lesscpy
lessc (node-less) and lesscpy do not produce the same output.
There are some minor whitespace +-1 in color values which
are not important but the output file is not stable

However lesscpy removes comments and so the license of the output file
As it produces an invalid file it support is dropped.

https://lesscpy.readthedocs.io/en/latest/#differences-from-less-js
2019-02-20 11:32:10 +01:00
Gunar Schorcht
e7b153cf80 doc: remove *_params.h from EXCLUDE_PATTERNS 2019-02-08 18:05:21 +01:00
Gunar Schorcht
b18d312ef5 doc: set STRIP_FROM_PATH
Set STRIP_FROM_PATH=../../ avoids having the output depend on the location of the RIOT repo in the user's fs.
2019-02-08 18:05:21 +01:00