Igt-dev Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Tales Aparecida <tales.aparecida@gmail.com>
To: igt-dev@lists.freedesktop.org
Cc: Tales Aparecida <tales.aparecida@gmail.com>
Subject: [igt-dev] [PATCH i-g-t v3 2/4] CONTRIBUTING: Add reference for GTKDoc
Date: Mon, 15 Aug 2022 13:35:05 -0300	[thread overview]
Message-ID: <20220815163505.36380-1-tales.aparecida@gmail.com> (raw)
In-Reply-To: <20220815145146.24038-1-tales.aparecida@gmail.com>

Add reference links about code documentation.

Signed-off-by: Tales Aparecida <tales.aparecida@gmail.com>
---

Notes:
    resend to fix incomplete patchwork

 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

  parent reply	other threads:[~2022-08-15 16:35 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-08-15 14:51 [igt-dev] [PATCH i-g-t v3 0/4] add kselftest runner documentation Tales Aparecida
2022-08-15 14:51 ` [igt-dev] [PATCH i-g-t v3 1/4] lib/igt_kmod: fix trivial typos Tales Aparecida
2022-08-15 14:51 ` [igt-dev] [PATCH i-g-t v3 2/4] CONTRIBUTING: Add reference for GTKDoc Tales Aparecida
2022-08-15 14:51 ` [igt-dev] [PATCH i-g-t v3 3/4] lib/kselftests: Skip kselftest when opening kmsg fails Tales Aparecida
2022-08-15 14:51 ` [igt-dev] [PATCH i-g-t v3 4/4] lib/igt_kmod: add igt_kselftests documentation Tales Aparecida
2022-08-15 16:46   ` André Almeida
2022-08-15 17:20     ` Tales
2022-08-15 17:23       ` André Almeida
2022-08-15 16:35 ` Tales Aparecida [this message]
2022-08-15 17:54 ` [igt-dev] ✓ Fi.CI.BAT: success for add kselftest runner documentation (rev3) Patchwork
2022-08-16  2:39 ` [igt-dev] ✗ Fi.CI.IGT: failure " Patchwork

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220815163505.36380-1-tales.aparecida@gmail.com \
    --to=tales.aparecida@gmail.com \
    --cc=igt-dev@lists.freedesktop.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox