From patchwork Tue Apr 21 10:03:09 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Wood X-Patchwork-Id: 6246441 Return-Path: X-Original-To: patchwork-intel-gfx@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork2.web.kernel.org (Postfix) with ESMTP id C00FCBF4A7 for ; Tue, 21 Apr 2015 10:03:17 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id E38EE203E6 for ; Tue, 21 Apr 2015 10:03:16 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) by mail.kernel.org (Postfix) with ESMTP id A8C8D2025B for ; Tue, 21 Apr 2015 10:03:15 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 91E756E3C4; Tue, 21 Apr 2015 03:03:14 -0700 (PDT) X-Original-To: intel-gfx@lists.freedesktop.org Delivered-To: intel-gfx@lists.freedesktop.org Received: from mail-wi0-f170.google.com (mail-wi0-f170.google.com [209.85.212.170]) by gabe.freedesktop.org (Postfix) with ESMTP id E446A6E3C4 for ; Tue, 21 Apr 2015 03:03:12 -0700 (PDT) Received: by wicmx19 with SMTP id mx19so59930267wic.1 for ; Tue, 21 Apr 2015 03:03:12 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:subject:date:message-id; bh=I9GAqIRbohFEbKS7RqFVIJZb4VybQhL2LyKjOgqaeKk=; b=LSCADhdsYr38uRoBYVTckJFRiI2Yi7xlwaZsy5bhptFgDXTbGSSB8asDHmiNeomZHe TIRUl9/zypW18BrztmrSY6eag/QZLb5MQY1JI4/v31VpycJJ1SAOj5zOAGCGP2Y3oUHA Zcfp3PgBdyu37HU9tSuHMVLzAVnq/VHvMGxeWhvmVHC0MQO646RD479YQd/0xyQkFvmj y288JMjkJbpS4hWTOc25EGgbKoWR9cJEMDbxSaYtcqbdpm14ZTVAzcGWDJDjNVuFhbLN 0dL5r7ntA4+JEgtDjsDCVUHfBMu+M3rVkxzENgtH/hGyrGBEOuOhv7WO0HWziD5GcpKs VzOQ== X-Gm-Message-State: ALoCoQnb6BQhQdbhJ1QKrVxhQCm3slq84WUx3BU2MKsBOh6DJ8JQjKmFZoDAUeFb5m/s8pGMbay1 X-Received: by 10.181.13.113 with SMTP id ex17mr4432689wid.12.1429610591899; Tue, 21 Apr 2015 03:03:11 -0700 (PDT) Received: from pistachio.icx.intel.com ([83.217.123.106]) by mx.google.com with ESMTPSA id ez19sm18952969wid.19.2015.04.21.03.03.10 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 21 Apr 2015 03:03:11 -0700 (PDT) From: Thomas Wood To: intel-gfx@lists.freedesktop.org Date: Tue, 21 Apr 2015 11:03:09 +0100 Message-Id: <1429610589-3632-1-git-send-email-thomas.wood@intel.com> X-Mailer: git-send-email 2.1.0 Subject: [Intel-gfx] [PATCH i-g-t] docs: avoid escaping characters in documentation comments X-BeenThere: intel-gfx@lists.freedesktop.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: Intel graphics driver community testing & development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" X-Spam-Status: No, score=-4.2 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_MED, T_RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Avoid having to escape certain characters in documentation comments by not allowing docbook markup tags. Markdown formatting in documentation comments is still supported. Signed-off-by: Thomas Wood --- docs/reference/intel-gpu-tools/Makefile.am | 2 +- lib/igt_aux.c | 2 +- lib/igt_core.c | 4 ++-- lib/igt_debugfs.c | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/reference/intel-gpu-tools/Makefile.am b/docs/reference/intel-gpu-tools/Makefile.am index 0033295..8364247 100644 --- a/docs/reference/intel-gpu-tools/Makefile.am +++ b/docs/reference/intel-gpu-tools/Makefile.am @@ -99,7 +99,7 @@ SCAN_OPTIONS=--rebuild-sections # Extra options to supply to gtkdoc-mkdb. # e.g. MKDB_OPTIONS=--xml-mode --output-format=xml -MKDB_OPTIONS=--xml-mode --output-format=xml +MKDB_OPTIONS=--output-format=xml # Extra options to supply to gtkdoc-mktmpl # e.g. MKTMPL_OPTIONS=--only-section-tmpl diff --git a/lib/igt_aux.c b/lib/igt_aux.c index 788ac3f..e011ef4 100644 --- a/lib/igt_aux.c +++ b/lib/igt_aux.c @@ -413,7 +413,7 @@ void igt_drop_root(void) * @var: var lookup to to enable this wait * * Waits for a key press when run interactively and when the corresponding debug - * var is set in the --interactive-debug=<var> variable. Multiple keys + * var is set in the --interactive-debug= variable. Multiple keys * can be specified as a comma-separated list or alternatively "all" if a wait * should happen for all cases. * diff --git a/lib/igt_core.c b/lib/igt_core.c index 700604f..7d04f2c 100644 --- a/lib/igt_core.c +++ b/lib/igt_core.c @@ -157,10 +157,10 @@ * test logic. * * - When adding a new feature test function which uses igt_skip() internally, - * use the <prefix>_require_<feature_name> naming scheme. When you + * use the _require_ naming scheme. When you * instead add a feature test function which returns a boolean, because your * main test logic must take different actions depending upon the feature's - * availability, then instead use the <prefix>_has_<feature_name>. + * availability, then instead use the _has_. * * - As already mentioned eschew explicit error handling logic as much as * possible. If your test absolutely has to handle the error of some function diff --git a/lib/igt_debugfs.c b/lib/igt_debugfs.c index df7f453..e7b69de 100644 --- a/lib/igt_debugfs.c +++ b/lib/igt_debugfs.c @@ -142,7 +142,7 @@ static igt_debugfs_t *__igt_debugfs_singleton(void) * @mode: mode bits as used by open() * * This opens a debugfs file as a Unix file descriptor. The filename should be - * relative to the drm device's root, i.e without "drm/<minor>". + * relative to the drm device's root, i.e without "drm/". * * Returns: * The Unix file descriptor for the debugfs file or -1 if that didn't work out. @@ -165,7 +165,7 @@ int igt_debugfs_open(const char *filename, int mode) * @mode: mode string as used by fopen() * * This opens a debugfs file as a libc FILE. The filename should be - * relative to the drm device's root, i.e without "drm/<minor>". + * relative to the drm device's root, i.e without "drm/". * * Returns: * The libc FILE pointer for the debugfs file or NULL if that didn't work out.