From: Emil Velikov Date: Mon, 21 Oct 2024 13:23:55 +0000 (+0100) Subject: CONTRIBUTING.md: mention about gtk-doc Since: X-Git-Tag: v34~177 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1e48f8a37add79ff0bc3080d71f3c31313cfe406;p=thirdparty%2Fkmod.git CONTRIBUTING.md: mention about gtk-doc Since: We don't have an easy way to test if API is missing a Since annotation, so mention that in the contributing guide. Signed-off-by: Emil Velikov Link: https://github.com/kmod-project/kmod/pull/200 Signed-off-by: Lucas De Marchi --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5abcf7aa..e35cb84b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -91,6 +91,9 @@ is wired to `meson test` to catch accidental mistakes or omissions. If you're unfamiliar with `gtk-doc` here is a [quick primer]. +When adding new API, make sure to include the `Since:` token and add a new +api-index section in `libkmod/docs/libkmod-docs.xml`. + ## Tools manual pages Our manual pages are written in [scdoc] a simple [markdown-like syntax]. Please