Corrected various spelling mistakes in comments, documentation, and
variable names across the project. Changes include:
- Documentation files (CONTRIBUTING.md, README.md, etc.)
- Source code comments in C/C++ files
- Function parameter names and descriptions
No functional changes were made.
Also advertise (only) the key/value syntax in usage.
\+ removed Macros from clang-tidy suggestion in CONTRIBUTING.md -
doesn't seem to perform better as for the changed line in this commit
(color_printf)
- added RCS, .clang-tidy and .editorconfig to .gitignore in order to
allow user to define own (not enforce for now)
- however, updated a suggested clant-tidy config in documentation
- also in CONTRIBUTING.md - add more clarification regarding pull
requests
- also suggested function-like macros to be upper-case - there doesn't
seem to be a general convention for that, but it seems to be better to
me, since it reduces the collision space (eg. MAX vs std::max) while
making more clear that this is a macro
+ added .clang-format to .gitignore
The style respects mostly rtp/rtp.{c,h} coding style (original
UltraGrid).
Rather than specifying own style, deduce one from clang-format default
format (just keeping the indention 8 spaces). The style is quite
restrictive because indention of 8 spaces + line with 80 restricts
nesting quite a bit.
Anyways, the style is rather a recommendation and is not enforced in any
way - .clang-format is just added to .gitignore and the developer can
tweak it a bit (like extending ColumnLimit).