]> git.ipfire.org Git - thirdparty/kmod.git/commitdiff
CONTRIBUTING.md: mention about gtk-doc Since:
authorEmil Velikov <emil.l.velikov@gmail.com>
Mon, 21 Oct 2024 13:23:55 +0000 (14:23 +0100)
committerLucas De Marchi <lucas.de.marchi@gmail.com>
Thu, 24 Oct 2024 04:19:11 +0000 (23:19 -0500)
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 <emil.l.velikov@gmail.com>
Link: https://github.com/kmod-project/kmod/pull/200
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
CONTRIBUTING.md

index 5abcf7aa6a3ff6586f1bb2c7566045917841a676..e35cb84bf1705a64cc43a5a733d360c6aa06e363 100644 (file)
@@ -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