Skip to content

Commit 8a0df4b

Browse files
committed
doc/guides: Getting Started
doc/guides: remove original windows guide
1 parent 2d044fd commit 8a0df4b

104 files changed

Lines changed: 1729 additions & 514 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.clang-tidy

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Reasoning
2+
# =========
3+
#
4+
# Selection of Checks
5+
# ------------------
6+
#
7+
# Selecting the following general purpose checks relevant for C code:
8+
# - clang-analyzer-* ()
9+
# - bugprone-*
10+
# - readability-*
11+
# - misc-*
12+
#
13+
# Additional checks for other languages or specific to projects/coding standards
14+
# are not used, expected for the Linux kernel coding conventions, as the RIOT
15+
# coding conventions builds upon the Linux coding conventions.
16+
#
17+
# Finally, the following checks are disabled:
18+
# - bugprone-reserved-identifier:
19+
# Too many false positives, as check does not take `static` declaration
20+
# into account
21+
# - bugprone-easily-swappable-parameters:
22+
# This cannot be avoided
23+
# - bugprone-too-small-loop-variable:
24+
# Too many false positives
25+
#
26+
#
27+
# Which Warnings to Raise to Errors
28+
# ---------------------------------
29+
#
30+
# - bugprone-*:
31+
# Avoiding known pitfalls or explicitly adding a magic comment and a
32+
# reasoning for why sticking with a footgun should be doable
33+
# - portability-*:
34+
# Porability issues bite us hard due to the wide varity of board,
35+
# toolchains, standard C libs, etc. we use. So we should avoid them
36+
# where possible
37+
#
38+
#
39+
# Fine Tuning
40+
# -----------
41+
#
42+
# - readability-function-cognitive-complexity.IgnoreMacros: 'true':
43+
# Otherwise the use of `DEBUG()...` will be penalized, even though it
44+
# helps both in debugging and to document the code.
45+
#
46+
# Warning
47+
# -------
48+
#
49+
# This configuration file is rather new and may enable a few warnings with a
50+
# low signal-to-noise ratio are may not enable checks that would be exteremely
51+
# helpful. If you modify this file to improve your experience, please consider
52+
# upstreaming the changes.
53+
---
54+
Checks: "clang-analyzer-*,
55+
bugprone-*,
56+
portability-*,
57+
readability-*,
58+
misc-*,
59+
linuxkernel-*,
60+
-bugprone-reserved-identifier,
61+
-bugprone-easily-swappable-parameters,
62+
"
63+
WarningsAsErrors: "bugprone-*,
64+
portability-*,
65+
"
66+
HeaderFilterRegex: ''
67+
FormatStyle: file
68+
CheckOptions:
69+
readability-function-cognitive-complexity.IgnoreMacros: 'true'

.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,6 @@ keys/
9494
# clangd language server
9595
.clangd/
9696

97-
# custom clang-tidy flags, also used when using clangd language server
98-
.clang-tidy
99-
10097
# Environments
10198
.venv
10299
venv/
Lines changed: 101 additions & 0 deletions
Lines changed: 72 additions & 0 deletions
Lines changed: 117 additions & 0 deletions

doc/guides/setup-windows/img/00-Install_Ubuntu-00.png renamed to doc/guides/getting-started/img/00-Install_Ubuntu-00.png

File renamed without changes.

doc/guides/setup-windows/img/00-Install_Ubuntu-01.png renamed to doc/guides/getting-started/img/00-Install_Ubuntu-01.png

File renamed without changes.

doc/guides/setup-windows/img/00-Install_Ubuntu-02.png renamed to doc/guides/getting-started/img/00-Install_Ubuntu-02.png

File renamed without changes.

doc/guides/setup-windows/img/00-Install_Ubuntu-03.png renamed to doc/guides/getting-started/img/00-Install_Ubuntu-03.png

File renamed without changes.

doc/guides/setup-windows/img/00-Install_Ubuntu-04.png renamed to doc/guides/getting-started/img/00-Install_Ubuntu-04.png

File renamed without changes.

0 commit comments

Comments
 (0)