165 Commits

Author SHA1 Message Date
Karl Fessel
e91dc15304 doc/search: do not hide search on mobile and make it work
move and resize results if they are not within the document-window

modify the search result display with some javascript patching
    (in page grease(tamper)monkey approach)
2020-07-04 15:15:58 +02:00
Leandro Lanzieri
045874abe6
Merge pull request #14050 from akshaim/Documentation_Update
doc/driver-guide.md : Update for compile-time configuration
2020-07-02 09:59:13 +02:00
Akshai M
d379009488 doc/driver-guide.md : Fix typo, punctuations and sentences 2020-07-01 21:59:42 +05:30
Akshai M
39a36f7fef doc/driver-guide.md : Fix syntax 2020-07-01 21:20:10 +05:30
Akshai M
b5902cadd5 doc/driver-guide.md : Update for compile-time configuration
Co-authored-by: Leandro Lanzieri <leandro.lanzieri@haw-hamburg.de>
Co-authored-by: Martine Lenders <mail@martine-lenders.eu>
2020-07-01 21:20:10 +05:30
Leandro Lanzieri
b8486782f0
doc/kconfig: Add guide to model features, CPUs and boards 2020-06-29 13:35:32 +02:00
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
Alexandre Abadie
0b778fec46
doc/porting-boards: add section about board generator 2020-05-20 19:05:40 +02:00
Alexandre Abadie
bdf4efa9bb
doc/creating-application: add section about example/test generator 2020-05-20 19:05:40 +02:00
Alexandre Abadie
f4ea2b97c8
doc/creating-modules: add section about module generator 2020-05-20 19:05:40 +02:00
Alexandre Abadie
26d3bc3b42
doc/driver-guide: add section about driver generator 2020-05-20 19:05:40 +02:00
Alexandre Abadie
53ea5ff883
doc/build-system-basics: fix typo 2020-05-08 11:29:39 +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
Jan Mohr
67569fbd56 doc/creating-modules: updated Pseudomodules entry 2020-02-28 16:51:53 +01:00
Alexandre Abadie
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
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
Alexandre Abadie
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
Alexandre Abadie
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
Alexandre Abadie
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
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
Martine Lenders
92b5ef594c doc: add reference to RIOT paper 2019-01-25 20:33:14 +01:00
Marinus Enzinger
dc8b8d7749 doc: add example for problems arising from non unique module names 2019-01-07 15:29:25 +01:00
Gaëtan Harter
e47fea7bf5
doc/advanced-build-system-tricks.md: add a doc for new variables
Add a documentation page for advanced low level tricks.
Document the `RIOT_MAKEFILES_GLOBAL_PRE` and
`RIOT_MAKEFILES_GLOBAL_POST`.

I could not work around to have `$(RIOTBASE)/Makefile.include` in the
doc as the `$()` part was removed, so I kept with `$RIOTBASE` for now.
2018-12-07 17:05:51 +01:00
Gaëtan Harter
4157a07152
tests/external_module_dir: test for EXTERNAL_MODULE_DIRS
It demonstrates:

 * Adding a module with source code
 * Setting a header include directory
 * Adding dependences, which are evaluated before other modules dependencies

If the application compiles, everything is ok.
2018-10-23 13:22:25 +02:00
Gaëtan Harter
6b534a935f
make: process include and dep for external modules
Process `Makefile.include` for external modules. It is included after the others
so it could overwrite some of the configuration if wanted.

Process `Makefile.dep` for external modules. It is included before the others so
it could be parsed before setting 'default' values to dependencies.
2018-10-23 13:22:25 +02:00
Alexandre Abadie
43c2b3201d doc/doxygen: fix typo in getting started page 2018-10-05 09:48:02 +02:00
Lotte Steenbrink
5a1184880a mainpage.md: fix dead link and 3 typos 2018-09-25 19:43:16 +02:00
Yegor Yefremov
b5527911f1 doc: fix quick guide command order
git checkout can only work if you've already changed to RIOT folder.
2018-05-25 12:22:09 +02:00
Gaëtan Harter
051d192e7f doc: fix 'EXTERNAL_MODULES_DIRS' name
Name in the documentation did not match the one in Makefile.include.
2018-04-19 13:20:19 +02:00
Martine Lenders
2c318e80dc
Merge pull request #8780 from miri64/doc/fix/dead-gmane-links
doc: mainpage: fix dead Gmane links
2018-03-15 12:34:26 +01:00