From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-vk1-xa36.google.com (mail-vk1-xa36.google.com [IPv6:2607:f8b0:4864:20::a36]) by gabe.freedesktop.org (Postfix) with ESMTPS id 318ECA9E86 for ; Mon, 15 Aug 2022 14:52:25 +0000 (UTC) Received: by mail-vk1-xa36.google.com with SMTP id c22so3779572vko.7 for ; Mon, 15 Aug 2022 07:52:25 -0700 (PDT) From: Tales Aparecida To: Petri Latvala , igt-dev@lists.freedesktop.org Date: Mon, 15 Aug 2022 11:51:44 -0300 Message-Id: <20220815145146.24038-3-tales.aparecida@gmail.com> In-Reply-To: <20220815145146.24038-1-tales.aparecida@gmail.com> References: <20220815145146.24038-1-tales.aparecida@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [igt-dev] [PATCH i-g-t v3 2/4] CONTRIBUTING: Add reference for GTKDoc List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: siqueirajordao@riseup.net, magalilemes00@gmail.com, tales.aparecida@gmail.com, Isabella Basso , andrealmeid@riseup.net, Trevor Woerner Errors-To: igt-dev-bounces@lists.freedesktop.org Sender: "igt-dev" List-ID: Add reference links about code documentation. Signed-off-by: Tales Aparecida --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6d1294ad..1c50063a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,6 +13,12 @@ The Code - The code should follow kernel coding style: https://www.kernel.org/doc/html/latest/process/coding-style.html +- The in-code documentation should follow GtkDoc specifications: + https://developer-old.gnome.org/gtk-doc-manual/stable/documenting.html. + For an updated version, you can also download the GtkDoc's + [source code][gtkdoc-repo] and open its manual with `yelp` directly by typing + in a terminal: `yelp file:///absolute/path/to/gtk-doc/help/manual/C/index.docbook` + - Testcases (subtests) have to use minus signs (-) as a word separator. The generated documentation contains glossary of commonly used terms. @@ -30,6 +36,7 @@ The Code provided by the igt library. The semantic patch lib/igt.cocci can help with more automatic conversions. +[gtkdoc-repo]: https://gitlab.gnome.org/GNOME/gtk-doc [igt-describe]: https://drm.pages.freedesktop.org/igt-gpu-tools/igt-gpu-tools-Core.html#igt-describe -- 2.37.1