lwn.git/net/batman-adv/hard-interface.h, branch docs-5.8-2

batman-adv: Update copyright years for 2020

2019-12-31T23:00:33+00:00

Signed-off-by: Sven Eckelmann Signed-off-by: Simon Wunderlich

batman-adv: Use includes instead of fwdecls

2019-05-25T10:59:53+00:00

While it can be slightly beneficial for the build performance to use forward declarations instead of includes, the handling of them together with changes in the included headers makes it unnecessary complicated and fragile. Just replace them with actual includes since some parts (hwmon, ..) of the kernel even request avoidance of forward declarations and net/ is mostly not using them in *.c file. Signed-off-by: Sven Eckelmann Signed-off-by: Simon Wunderlich

batman-adv: Drop license boilerplate

2019-03-25T08:31:35+00:00

All files got a SPDX-License-Identifier with commit 7db7d9f369a4 ("batman-adv: Add SPDX license identifier above copyright header"). All the required information about the license conditions can be found in LICENSES/. Signed-off-by: Sven Eckelmann Signed-off-by: Simon Wunderlich

batman-adv: Update copyright years for 2019

2019-01-04T10:04:24+00:00

Signed-off-by: Sven Eckelmann Signed-off-by: Simon Wunderlich

batman-adv: Update copyright years for 2018

2018-02-26T16:57:39+00:00

Signed-off-by: Sven Eckelmann Signed-off-by: Simon Wunderlich

batman-adv: Add kernel-doc to functions in headers

2017-12-15T16:29:23+00:00

Externally visible functions should be documented with kernel-doc. This usually refers to non-static functions but also static inline files in headers are visible in other files and should therefore be documented. Signed-off-by: Sven Eckelmann Signed-off-by: Simon Wunderlich

batman-adv: Add kernel-doc to enums in headers

2017-12-15T16:29:22+00:00

All enums in types.h are already documented. But some other headers still have private enums which also should be documented. Signed-off-by: Sven Eckelmann Signed-off-by: Simon Wunderlich

batman-adv: Use inline kernel-doc for enum/struct

2017-12-15T16:29:20+00:00

The inline kernel-doc comments make it easier to keep changes to the struct/enum synchronized with the documentation of the it. And it makes it easier for larger structures like struct batadv_priv to read the documentation inside the code. Signed-off-by: Sven Eckelmann Signed-off-by: Simon Wunderlich

batman-adv: Use parentheses in function kernel-doc

2017-12-15T16:29:20+00:00

The documentation describing kernel-doc comments for functions ("How to format kernel-doc comments") uses parentheses at the end of the function name. Using this format allows to use a consistent style when adding documentation to a function and when referencing this function in a different kernel-doc section. Signed-off-by: Sven Eckelmann Signed-off-by: Simon Wunderlich

batman-adv: Add SPDX license identifier above copyright header

2017-12-15T16:22:45+00:00

The "Linux kernel licensing rules" require that each file has a SPDX license identifier as first line (and sometimes as second line). The FSFE REUSE practices [1] would also require the same tags but have no restrictions on the placement in the source file. Using the "Linux kernel licensing rules" is therefore also fulfilling the FSFE REUSE practices requirements at the same time. [1] https://reuse.software/practices/ Signed-off-by: Sven Eckelmann Signed-off-by: Simon Wunderlich