86 Commits

Author SHA1 Message Date
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
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
Martine Lenders
3dec4720b8 doc: replace conn with sock in GNRC architecture overview 2018-02-27 11:02:39 +01:00
Joakim Nohlgård
22c52bd3a8 kinetis: Unify all Kinetis CPUs in one directory 2017-11-10 10:42:59 +01:00
Joakim Nohlgård
329517f08d boards: Remove executable bit on various non-executable files 2017-10-13 10:29:34 +02:00
smlng
6ac0922c7d doc: replace dashes 2017-09-06 08:49:05 +02:00
Alexandre Abadie
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
Oleg Hahm
32ef8f8351 Merge pull request #6359 from OlegHahm/pkg_openwsn_remove
pkg: remove OpenWSN
2017-01-18 22:25:33 +01:00
Oleg Hahm
cafafd5744 doc: escape hash character 2017-01-16 18:04:04 +01:00
Oleg Hahm
8a9f6a31a6 doc: replace pkg example in documentation 2017-01-14 15:20:51 +01:00
Martine Lenders
16bcffc69b doc: add operational flow figure for netdev 2016-06-15 23:26:22 +02:00
Martine Lenders
8c52d3e364 doc: fix typo 2016-04-08 16:08:40 +02:00
Oleg Hahm
8e6dc1a03f doc: updated and clarified tapsetup usage 2016-03-10 17:40:22 +01:00
Martine Lenders
8a588575f3 doc: fix link to devel mailman 2016-02-05 13:39:46 +01:00
Martine Lenders
b5f5f8314a doc: add page about creating modules 2015-12-19 14:18:18 +01:00