38a263efab
doc/emulator: update qemu doc with unix sockets
2022-03-04 13:30:14 +01:00
chrysn
6fbf36cdf4
doc/memo: Link to RDMs in development
2022-03-02 15:08:15 +01:00
Karl Fessel
52116e1070
Merge pull request #17572 from kfessel/p-set-doxygen-example-path
...
doc: add RIOT root to doxygen example path
2022-02-28 15:42:25 +01:00
chrysn
204a622fc3
doc/rust: Remove duplicate (and wrong) line
...
The duplication happened already in the initial version, and when
[17504] had the `--locked` added, the opportunity to remove the
duplication was missed.
[17504]: https://github.com/RIOT-OS/RIOT/pull/17504
2022-02-24 16:53:02 +01:00
Benjamin Valentin
35ecfadf54
doc/porting-boards.md: update documentation of board_init()
2022-02-22 18:27:37 +01:00
aaa2a7939d
doc: introduce debugging-aids.md, start with ubsan
2022-02-16 12:20:45 +01:00
chrysn
f7dfa2f84d
Merge pull request #17133 from chrysn-pull-requests/doc-develhelp-stackoverflow-precision
...
doc: Start documenting pseudomodules
2022-01-27 15:09:22 +01:00
chrysn
68d0c291a9
doc: Initial documentation of pseudomodules
...
Co-authored-by: Francisco <femolina@uc.cl>
2022-01-27 13:49:14 +01:00
Karl Fessel
fb9bd122b3
doc: set example path to RIOT root
2022-01-25 17:26:38 +01:00
Leandro Lanzieri
6257442e4e
doc: Add project name
2022-01-19 10:17:52 +01:00
Marian Buschsieweke
d788bd327d
Merge pull request #17504 from chrysn-pull-requests/doc-c2rust-locked
...
doc: Fix C2Rust installation procedure
2022-01-17 17:40:38 +01:00
chrysn
e7a9e125d4
doc: Point to test README for details
2022-01-13 12:52:09 +01:00
chrysn
acbbb405b0
doc: Fix C2Rust installation procedure
...
The `--locked` is required since dependencies increased their MSRV to
something later than C2Rust's fixed nightly. That was already reflected
in the riotdocker installation steps, but not here where the line was
taken from upstream's docs.
Closes: https://github.com/RIOT-OS/RIOT/issues/17492
2022-01-12 08:56:13 +01:00
23ab8431a7
Merge pull request #17412 from jenswet/feature/cpp-doxygen-documentation
...
doc: Improve C++ documentation
2021-12-21 12:32:47 +01:00
chrysn
9b66bd59e1
rust: Add overview documentation
2021-12-19 11:15:04 +01:00
Jens Wetterich
a0930a8ec0
doc: Improve C++ documentation
...
Move C++ modules in a new menu tree and improve the description.
2021-12-15 18:58:23 +01:00
Leandro Lanzieri
c8533e6f23
doc/kconfig: add information on default configurations
2021-12-13 12:33:24 +01:00
Francisco Molina
cc001a81e1
Makefile.base: add SUBMODULE_NO_SRC to excluded a selected SUBMODULE *.c
...
This allows for SUBMODULE PSEUDOMODULES to conditionally not be linked
to an existing *.c file.
2021-11-16 22:40:11 +01:00
Leandro Lanzieri
f64b166319
Merge pull request #16845 from MrKevinWeiss/pr/kconfig/supportstms
...
.murdock: Add nucleo boards to kconfig test
2021-11-01 09:55:22 +01:00
Jnae
5bb4d29aed
doc/getting-started.md: added beginner friendly instructions
2021-10-27 08:15:42 +02:00
benpicco
ca1ab67a9d
Merge pull request #17002 from maribu/doc/getting-started
...
doc/.../getting-started.md: update software requirements
2021-10-20 14:02:05 +02:00
Marian Buschsieweke
ba859613d4
doc/.../getting-started.md: update software requirements
2021-10-19 11:26:42 +02:00
Benjamin Valentin
ccae474cf8
doc/porting-boards.md: update documentation of board_init()
2021-10-18 12:33:48 +02:00
MrKevinWeiss
c9ffb8d2af
board/common/nucleo: Use and doc HAVE_* Kconfig
2021-10-14 11:28:42 +02:00
3274bbb1cf
doc/emulators: documented info-emulated-boards target
2021-10-12 10:42:49 +02:00
benpicco
a39c0e1010
Merge pull request #16750 from benpicco/gnrc_ipv6_auto_subnets
...
gnrc/ipv6_auto_subnets: relax topology requirements
2021-09-28 19:07:21 +02:00
Benjamin Valentin
6742fb8076
gnrc/ipv6_auto_subnets: relax topology requirements
2021-09-28 16:57:10 +02:00
Martine Lenders
77f7db1e0d
Merge pull request #15981 from miri64/doc/enh/porting-graph
...
doc/porting-boards.md: improve with porting graph and reference section
2021-09-16 18:53:40 +02:00
Martine Lenders
aaa9512d50
doc/porting-boards.md: improve with porting graph and reference section
2021-09-16 16:54:42 +02:00
Kevin "Tristate Tom" Weiss
73e32207df
Merge pull request #16052 from miri64/dist/enh/genconfig-env
...
makefiles/kconfig.mk: generate config file from RIOT_CONFIG_% environment variables
2021-09-08 11:00:59 +02:00
Martine Lenders
5a44f6b4cf
doc: add documentation on RIOT_CONFIG_ variables
2021-09-07 11:23:12 +02:00
d96a7f98c7
Merge pull request #16810 from fjmolinas/pr_no_udev_link
...
doc/doxygen/src/advanced-build-system-tricks: fix no udev link
2021-09-03 20:20:37 +02:00
Francisco Molina
b26e4c0116
doc/doxygen/src/advanced-build-system-tricks: fix no udev link
2021-09-03 19:28:52 +02:00
benpicco
9ac9b41a57
Merge pull request #16536 from benpicco/gnrc_ipv6_nib_subnets
...
gnrc_ipv6_simple_subnets: auto-configuration for nested subnets on a simple tree topology
2021-09-02 16:24:53 +02:00
Benjamin Valentin
b208db0f27
gnrc_ipv6_auto_subnets: auto-configuration for nested subnets
...
If we get a large (e.g. /62) prefix from e.g. DHCPv6, we can split it
into subnets automatically to configure downstream interfaces.
This allows for automatic configuration of daisy-chained nodes or
nodes connected in a tree topology.
To enable the feature, a new pseudo-module `gnrc_ipv6_auto_subnets` is
provided.
2021-09-02 15:35:14 +02:00
Martine Lenders
1bf18b3239
doc/doxygen/riot.doxyfile: remove obsolete and fix wrong options
2021-08-31 19:20:37 +02:00
dylad
c488f96971
doc/doxygen: increase DOT_GRAPH_MAX_NODES to 275
2021-07-27 21:20:34 +02:00
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
d7f6387019
doc/rdm1: fix URL to poster abstract
2021-05-05 10:00:48 +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
204a608c24
doc: Make bootloaders visible in modules
2021-02-18 14:56:20 +01:00
chrysn
711e9ab3b6
doc: Warn against blocking in board_init
2021-02-15 06:01:29 +01:00
Akshai M
b9d84e0b3e
doc/porting-cpus.md: initial import of a CPU porting guide
2021-02-10 15:45:59 +01:00
c9e0604612
doc: add emulator documentation
2021-01-13 17:14:39 +01:00
Martine Lenders
d145b0d7d8
doc: generate-changelog: add support for point releases
2021-01-08 14:46:10 +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
Gilles DOFFE
f07f93fec9
doxygen: increase DOT_GRAPH_MAX_NODES
...
Signed-off-by: Gilles DOFFE <gilles.doffe@savoirfairelinux.com>
2020-09-02 11:11:29 +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
Karl Fessel
5e757b1a9c
doc/search: Patch search to display results bigger if hitting return
2020-07-03 23:40:00 +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
Karl Fessel
f09064c40c
doc/header: make hitting return not reload the page
...
adding onsubmit="return false" stops form submition which leads to reload
2020-07-01 12:58:05 +02:00
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
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
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
Emmanuel Baccelli
793072cb13
Merge pull request #10162 from danpetry/doc/rdm1-RIOT-design-goals
...
doc/rdm: RFC - design goals
2019-05-09 11:04:24 +02:00
danpetry
c3bd937128
doc/rdm: Update README contents
...
Update README to include a reference to the new document.
2019-05-03 16:26:47 +02:00
danpetry
6ea67abefc
doc/rdm: rdm1 - RIOT design goals
...
Initial commit of document.
2019-05-03 16:26:46 +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
Gunar Schorcht
20d5f30ad4
doc: set FULL_PATH to yes
...
Using FULL_PATH=yes avoids that paths in documentation seem to be arbitrary.
2019-02-08 18:05:21 +01:00
Gunar Schorcht
cdcf503adf
doc: remove STRIP_FROM_INC_PATH
...
To be able to include *_params.h in docuementation, STRIP_FROM_INC_PATH has to be empty. Otherwise, a number of warnings are thrown if *_params.h files with same names exist in different directories.
2019-02-08 18:05:21 +01:00
Martine Lenders
92b5ef594c
doc: add reference to RIOT paper
2019-01-25 20:33:14 +01:00
danpetry
b79910995d
doc/rdm: clarification to change process
2019-01-17 12:06:28 +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
Emmanuel Baccelli
48c981b1e2
rdm : initial rdm directory + rdm0
2018-10-12 19:11:08 +02:00
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
Jose Alamos
7d286ec3f3
doc: set SUBGROUPING to NO in riot.doxyfile
2018-08-29 17:57:13 +02:00
Cenk Gündoğan
dc3c49ea88
Merge pull request #8948 from miri64/doc/enh/experimental-command
...
doc: doxygen: add command
2018-06-26 22:33:33 +02:00
Bas Stottelaar
6464e12713
doc: exclude fortuna sources
2018-05-29 18:40:59 +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
9001b165f6
doc: fix flake8 in generate changelog script
2018-04-27 15:15: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
8e5e2061e9
doc: doxygen: add command
2018-04-13 17:55:15 +02:00
61f1b941ce
make: replace curly braces with parenthesis
2018-03-22 20:43:15 +01: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
Martine Lenders
2475254d25
doc: mainpage: fix dead Gmane links
...
Gmane is sadly offline since 2016, so let's link to our own (not so
nice) archive for now, so people can still at least crawl through it.
2018-03-14 16:13:32 +01:00
Gaëtan Harter
e5d234e2f4
doc: add warning that MODULE name should be unique
...
Modules produce an output archive called `${MODULE}.a` if several modules use
the same name, the output is overwritten.
2018-03-14 12:29:22 +01:00
e5bce7af82
doc/doxygen: enable doc on openthread package
2018-03-07 11:10:32 +01:00
e73cc86b87
doc/doxygen: enable doc on nordic_softdevice_ble pkg
2018-03-01 15:31:08 +01:00
0276bef20c
doc/doxygen: enable doc on semtech-loramac package
2018-03-01 14:06:54 +01:00
e764a60a9a
doc/doxygen: enable parsing of packages docs
...
Exception are made for emb6, nordic_softdevice_ble, openthread and semtech-loramac because their documentation contains warning/issues
2018-02-28 14:49:19 +01:00
Martine Lenders
3dec4720b8
doc: replace conn with sock in GNRC architecture overview
2018-02-27 11:02:39 +01:00
Hauke Petersen
dcd297d837
doxygen: remove x86-multiboot from excludes
2017-11-16 13:42:03 +01:00
Joakim Nohlgård
22c52bd3a8
kinetis: Unify all Kinetis CPUs in one directory
2017-11-10 10:42:59 +01:00
a7d575b8d6
doc: increase GRAPH_MAX_NODES to avoid warning
2017-11-05 22:14:30 +01:00
Joakim Nohlgård
329517f08d
boards: Remove executable bit on various non-executable files
2017-10-13 10:29:34 +02:00
Joakim Nohlgård
d01d91d3c3
doxygen: Use lesscpy if lessc is not found
2017-09-28 19:27:50 +02:00
smlng
6ac0922c7d
doc: replace dashes
2017-09-06 08:49:05 +02:00
Joakim Nohlgård
e08cb90b12
Merge pull request #7520 from haukepetersen/rm_weio_lostandfound
...
doc: added LOSTANDFOUND.md
2017-09-04 11:58:15 +02:00
Hauke Petersen
627596eece
doxygen: added removed feature document as page
2017-09-01 14:26:39 +02:00
Joakim Nohlgård
b621cb54a8
doc: Enable REPEAT_BRIEF in Doxygen
...
The detailed documentation of some functions need the brief description
included to make sense.
2017-08-11 07:49:52 +02:00
0ba641a6d2
doc: restore syntax highlight in C snippet + increase padding of code fragment blocks
2017-07-17 18:15:46 +02:00
Martine Lenders
36c7eb9ac8
doc: fix rendering of multi-breadcrumbed groups
2017-07-03 17:05:54 +02:00
Martine Lenders
cc0c8a1947
doc: introduce memtitle class
...
Our doc builder at doc.riot-os.org was updated and now the documentation
looks weird (see http://doc.riot-os.org/group__core__msg.html#gad1353dec9af776d4caf5f4e00cec112e
e.g.). This fixes that.
2017-06-25 13:49:48 +02:00
Raul Fuentes
1c0653f383
Doxygen: Completed line for Makefile.base
2017-05-30 20:48:57 +02:00
Martine Lenders
cac6da3fb7
doc: fix "Creating an application" page
2017-05-24 18:23:30 +02:00
Martine Lenders
0469dec71e
doc: add release notes to doxygen documentation
...
Provides a script to generate a doxygen page from the
`release-notes.txt` and includes it to the doxygen build.
2017-05-12 17:54:48 +02:00
Joakim Nohlgård
032c3b6883
Merge pull request #6914 from miri64/doc/fix/smartmenus
...
doc: utilize smartmenus
2017-04-25 11:05:45 +02:00
Martine Lenders
b092179787
doc: utilize smartmenus
2017-04-25 09:35:50 +02:00
Martine Lenders
c00a89fd9e
doc: fix spacing in parameter description
...
Fixes #6953
2017-04-24 13:51:43 +02:00
Martine Lenders
d076d855c5
Merge pull request #6908 from miri64/doc/enh/less-conf
...
doc: add build capacities for LESS
2017-04-18 15:29:03 +02:00
Martine Lenders
1724b97b23
doc: add build capacities for LESS
2017-04-18 13:23:34 +02:00
Martine Lenders
75eef79c9e
doc: add favicon
2017-04-14 03:00:47 +02:00
Martine Lenders
8ea20ea505
doc: Doxygen beautification
2017-04-13 16:41:52 +02:00
Martine Lenders
4dad2baae7
doc: add note about security@riot-os.org
2017-04-05 12:00:36 +02:00
Martine Lenders
29842bb5e4
netdev2: rename to netdev and remove gnrc_netdev
...
With some minor hand-edits I used the following chain of commands:
```sh
git rm sys/include/net/gnrc/netdev.h
git grep --name-only -i netdev2 | \
xargs sed -i -e 's/^\(NETDEV\)2\(.*\)\( [("]\)/\1\2 \3/g' \
-e 's/\(netdev\)2\(.*\)\( \/\*\*<\)/\1\2 \3/I' \
-e 's/\(netdev\)2/\1/gI'
git add -p
git commit --amend
git ls-tree --full-tree -r HEAD --name-only | \
grep "netdev2" | xargs -I'{}' dirname '{}' | uniq | \
grep "netdev2" | while read dir; do
new_dir="$(echo "$dir" | sed "s/netdev2/netdev/g")"
git mv -f "$dir" "$new_dir"
done
git commit --amend
git ls-tree --full-tree -r HEAD --name-only | \
grep "netdev2" | while read file; do
new_file="$(echo "$file" | sed "s/netdev2/netdev/g")"
git mv -f "$file" "$new_file"
done
git commit --amend
git grep --name-only "\<drivers_netdev_netdev\>" | \
xargs sed -i "s/\<drivers_netdev_netdev\>/drivers_netdev_api/g"
git add -p
git commit --amend
```
2017-03-15 09:31:20 +01:00
Peter Kietzmann
db6bf02168
Merge pull request #6711 from haukepetersen/opt_doc_nrf24
...
drivers/nrf24l01: removed doxgen warnings
2017-03-13 23:39:48 +01:00
Oleg Hahm
350a55b58f
doc: increase number of nodes for doxygen graphs
2017-03-10 14:56:48 +01:00
Oleg Hahm
28c335e8e7
doc: exclude _param files from doxygen
2017-03-10 14:56:48 +01:00
Oleg Hahm
5ff3a1c957
doc: doxygen: update exclude paths
2017-03-10 14:56:48 +01:00
Joakim Nohlgård
738876a98f
cpu/atmega_common: Improve POSIX headers
2017-03-07 17:59:57 +01:00
Hauke Petersen
e6db9587db
drivers/nrf24l01: removed doxgen warnings
...
- de-blacklisted nrf24l01p_settings.h from doxygen excludes
- fixed doc for that file
2017-03-07 12:19:43 +01:00
Hauke Petersen
fa59955eff
doc: removed CPU excludes from doxyfile
2017-03-07 08:55:04 +01:00
36e8fb8e56
doc/doxygen: exclude cpu/stm32l0 directory from doxygen
2017-02-24 16:12:01 +01:00
Joakim Nohlgård
bec5b57f0d
doc/doxygen: Exclude msp430-common imported newlib headers
2017-02-08 16:23:50 +01:00
Joakim Nohlgård
4bd62d241f
doc/doxygen: Sort exclude patterns
2017-02-08 16:10:12 +01:00
smlng
887f499eca
drivers/kw2xrf: adapt to new SPI interface
...
- add docu for structs, defines and functions
- exclude drivers/kw2xrf/include/overwrites.h (vendor header)
- add missing header guards
2017-02-07 15:08:05 +01:00
Oleg Hahm
5578d57387
Merge pull request #6395 from gebart/pr/doxygen-strip-include-fix
...
doc: Doxygen strip include fix
2017-01-20 09:14:17 +01:00
Oleg Hahm
32ef8f8351
Merge pull request #6359 from OlegHahm/pkg_openwsn_remove
...
pkg: remove OpenWSN
2017-01-18 22:25:33 +01:00
