doc/developer: add warning pointers

These two warnings are easy to get confused by, note down some pointers
on what they actually mean.

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
This commit is contained in:
David Lamparter 2021-09-01 17:13:09 +02:00
parent 09e33fbe6b
commit e5af0fc869

View File

@ -1217,6 +1217,20 @@ it possible to use your apis in paths that involve ``const``
objects. If you encounter existing apis that *could* be ``const``,
consider including changes in your own pull-request.
Help with specific warnings
^^^^^^^^^^^^^^^^^^^^^^^^^^^
FRR's configure script enables a whole batch of extra warnings, some of which
may not be obvious in how to fix. Here are some notes on specific warnings:
* ``-Wstrict-prototypes``: you probably just forgot the ``void`` in a function
declaration with no parameters, i.e. ``static void foo() {...}`` rather than
``static void foo(void) {...}``.
Without the ``void``, in C, it's a function with *unspecified* parameters
(and varargs calling convention.) This is a notable difference to C++, where
the ``void`` is optional and an empty parameter list means no parameters.
.. _documentation: