1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-15 23:32:59 +01:00
Commit Graph

148 Commits

Author SHA1 Message Date
062c0e550c
doxygen: Replace Freenode IRC with the Matrix room
Can be replace and/or extended with a new IRC room as soon as the poll
is closed:
https://forum.riot-os.org/t/riot-irc-channel-and-the-freenode-turmoil/3242/28
2021-06-18 11:05:26 +02:00
Martine Lenders
0978084d1e
Merge pull request #16345 from miri64/doc/enh/release-cycle
doc: README: Add documentation on downloads and release cycle
2021-05-17 09:48:53 +02:00
Jean Pierre Dudey
33539f137a
Merge pull request #16428 from bergzand/pr/readme/remove_ml
Documentation: Remove mentions of the users@ and devel@ mailing lists.
2021-05-12 13:44:07 +02:00
059be06217
doxygen: Remove users@ and devel@ mailing lists 2021-05-12 11:41:25 +02:00
Francisco
8cb8bba4e7
Merge pull request #16104 from maribu/external_modules
build system: Rework EXTERNAL_MODULE_DIRS
2021-05-07 23:27:17 +02:00
Marian Buschsieweke
6ac8aba955
build system: rework EXTERNAL_MODULE_DIRS
Previously, external modules had to be individually added to both
EXTERNAL_MODULE_DIRS and USEMODULE. If those where not in sync, this
resulted in build errors.

With this commit, search folders for external modules are added to
EXTERNAL_MODULE_DIRS instead. So lets say the file system structure is
like this

```
└── /path/to/external/modules
    ├── mod_a
    │   ├── Makefile
    │   ├── Makefile.dep
    │   ├── Makefile.include
    │   ├── foo.c
    │   └── include
    │       └── external_module.h
    └── mod_b
        ├── Makefile
        └── bar.c

```

One now adds `/path/to/external/modules` to EXTERNAL_MODULES and only
with `USEMODULE += mod_a` the corresponding module, dependencies and
include settings are actually used. Hence, it is possible to configure
`EXTERNAL_MODULE_DIRS` from `~/.profile` or `~/.bashrc` once and never
needs to worry about them again.
2021-05-07 21:29:05 +02:00
Leandro Lanzieri
ec3e540931
doc/mainpage: fix RIOT paper URL 2021-05-05 09:41:48 +02:00
Martine Lenders
af7152eeca
doxygen: add release cycle page 2021-05-04 11:54:15 +02:00
Marian Buschsieweke
a07dac9ad1
build system: add new compile-commands make target
By running make compile-commands a `compile_commands.json` in the RIOT base
directory. With the environment variable `COMPILE_COMMANDS` the path of
this file can be changed to a custom location.

The `compile_commands.json` will contain the exact compile command, but
as additional flag `-I/usr/$(TARGET)/include` is added to work around
`clangd` not being able to locate the newlib system headers. The
additional includes can be overwritten using the environment variable
`COMPILE_COMMANDS_EXTRA_INCLUDES`.
2021-04-14 14:51:46 +02:00
Leandro Lanzieri
79fe7274ca
doc: add documentation on default configurations 2021-03-10 14:18:09 +01:00
chrysn
711e9ab3b6 doc: Warn against blocking in board_init 2021-02-15 06:01:29 +01:00
c9e0604612
doc: add emulator documentation 2021-01-13 17:14:39 +01:00
b8efd8425d
doc/kconfig: fix typo (bellow => below) 2021-01-08 10:15:32 +01:00
Martine Lenders
a28af88e02
doc: add link to forum on the main page 2020-12-10 10:10:03 +01:00
b31357eccc
doc: update Makefile.include instructions
Specify the programmer using the PROGRAMMER variable, don't include programmer specific makefile and serial makefile
2020-12-02 11:57:10 +01:00
Karl Fessel
2e9bdf0635 doc: add jquerry.scrollTo for less timers in html doc
see #15503

add jquerry.scrollTo
add the code to copy and load scrollTo
2020-11-24 20:28:47 +01:00
benpicco
be9eb22bb8
Merge pull request #15106 from chrysn-pull-requests/saul-rgbleds
saul_pwm: auto-init'able RGB LEDs and dimmers
2020-11-13 18:22:30 +01:00
5281a1b155
doc: add Docker info to doxygen 2020-11-13 11:50:50 +01:00
chrysn
d196c7c4a6 drivers/saul/auto_init: Add PWM for LEDs
In analogy to the existing GPIO mappings, this provides (write-only)
SAUL entries for PWM'd LEDs in a single-LED (as SAUL_ACT_DIMMER) and an
RGB (as SAUL_ACT_RGB_LED) mode.

Co-authored-by: Marian Buschsieweke <marian.buschsieweke@ovgu.de>
2020-10-17 11:20:17 +02:00
benpicco
5c9e0dfa93
Merge pull request #15154 from aabadie/pr/doc/cleanup_readme
README.md: move tapsetup section to documentation
2020-10-06 10:31:25 +02:00
c07805fb07
Merge pull request #15152 from bergzand/pr/doxygen/square_faviconpng
doxygen: Replace favicon with square png
2020-10-03 16:40:08 +02:00
b5b3491726
doc: add tapsetup note in getting-started page 2020-10-03 16:03:05 +02:00
10aaca82aa
doxygen: Replace favicon with square png
The previous favicon was a 35x40 png file. Some (if not all) browsers
stretch the icon to a square. This stretched the original favicon
without keeping the aspect ratio. This commit replaces the favicon with
a square 128x128 png image.
2020-10-03 14:34:55 +02:00
Francisco
df3ab9f161
Merge pull request #15138 from aabadie/pr/dist/codespell_fixes
dist/codespell: update the list of ignored words and fix all typos
2020-10-02 12:27:12 +02:00
f8b78593a2
doc: fix typos
- 'adminstrative' -> 'administrative'
- 'Ouput' -> 'Output'
2020-10-02 08:00:51 +02:00
2213b25f8f
doc/kconfig: mention possible intermediate CPU levels
Such as CPU_LINES_<xxx> on STM32
2020-10-01 18:25:35 +02:00
a239bcb015
doc: Extend tricks with Make-only board selector
This extends the 'Advanced build system tricks' section with a make
script to select the board debugger and serial based on the USB serial
number as reported by the device. This solution is different from the
udev-rule solution as it doesn't require administrative permissions.
2020-09-28 14:26:46 +02:00
Marian Buschsieweke
4a016adebb
doc/driver-guide.md: Update doc on return value
Change driver guide to expect drivers to return negative errno codes instead of
enums for error codes. Those have the following advantages:

- More efficient implementation of POSIX compatibility wrappers:
    - In case of error, just an `errno = -retval; return -1` is needed
- Better interoperability
    - A lot of code within RIOT and in external code is doing so already.
      Applying this consistently allows passing error codes through, rather
      than translating between errno codes and custom enum values
- Not reinventing the wheel
    - Defining and documenting custom error codes for each driver is unneeded
      effort
    - The error classes that device driver have to report are largely the same.
      There is no reason to have dozens of error codes for an input/output
      error, each with a unique spelling a programmer needs to memorize
2020-09-22 14:38:56 +02:00
Leandro Lanzieri
d25fc243c4
treewide: change prefix for generated Kconfig symbols.
This changes the prefixes of the symbols generated from USEMODULE and
USEPKG variables. The changes are as follow:

   KCONFIG_MODULE_ => KCONFIG_USEMODULE_
   KCONFIG_PKG_ => KCONFIG_USEPKG_
   MODULE_ => USEMODULE_
   PKG_ => USEPKG_
2020-08-31 09:37:09 +02:00
Leandro Lanzieri
8feb03c18d
doc/kconfig: update to current behaviour and used files 2020-08-07 18:17:38 +02:00
benpicco
f3bce19646
Merge pull request #14503 from maribu/cpp-feature
build system: Add libstdcpp feature and doc
2020-07-23 19:05:10 +02:00
628777fa90
doc: adapt driver guide documentation 2020-07-15 20:36:27 +02:00
Marian Buschsieweke
cf482c5d46
build system: Add libstdcpp feature and doc
- Add libstdcpp feature to indicate a platform is providing a libstdc++
  implementation ready for use
- The existing cpp feature now only indicates a working C++ toolchain without
  libstdc++. (E.g. still useful for the Arduino compatibility layer.)
- Added libstdcpp as required feature were needed
- Added some documentation on C++ on RIOT
2020-07-15 11:45:22 +02:00
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
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
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