From patchwork Mon Aug 28 08:12:03 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paul Kocialkowki X-Patchwork-Id: 9924539 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 7B4C860311 for ; Mon, 28 Aug 2017 08:12:19 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 661B328682 for ; Mon, 28 Aug 2017 08:12:19 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 64C34286B5; Mon, 28 Aug 2017 08:12:19 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-4.2 required=2.0 tests=BAYES_00, RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id BAA44286A9 for ; Mon, 28 Aug 2017 08:12:18 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 1859A6E0C9; Mon, 28 Aug 2017 08:12:18 +0000 (UTC) X-Original-To: intel-gfx@lists.freedesktop.org Delivered-To: intel-gfx@lists.freedesktop.org Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by gabe.freedesktop.org (Postfix) with ESMTPS id 3CD306E0C9 for ; Mon, 28 Aug 2017 08:12:16 +0000 (UTC) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 28 Aug 2017 01:12:15 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.41,440,1498546800"; d="scan'208";a="128896361" Received: from linux.intel.com ([10.54.29.200]) by orsmga002.jf.intel.com with ESMTP; 28 Aug 2017 01:12:14 -0700 Received: from workstation.fi.intel.com (workstation.fi.intel.com [10.237.68.31]) by linux.intel.com (Postfix) with ESMTP id D13035804B9; Mon, 28 Aug 2017 01:12:12 -0700 (PDT) From: Paul Kocialkowski To: intel-gfx@lists.freedesktop.org Date: Mon, 28 Aug 2017 11:12:03 +0300 Message-Id: <20170828081205.2928-2-paul.kocialkowski@linux.intel.com> X-Mailer: git-send-email 2.14.0 In-Reply-To: <20170828081205.2928-1-paul.kocialkowski@linux.intel.com> References: <20170828081205.2928-1-paul.kocialkowski@linux.intel.com> Subject: [Intel-gfx] [PATCH i-g-t v2 1/3] lib/igt_core: Use HTML character for documentation comment in example 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-Virus-Scanned: ClamAV using ClamSMTP The gtkdoc output for the example configuration given in the file confuses gtkdoc because of the use of # for comments, that is interpreted as a headline (although it is an example block). This uses the HTML character instead to ensure the rendering is correct. Signed-off-by: Paul Kocialkowski --- lib/igt_core.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/igt_core.c b/lib/igt_core.c index 58d64dc2..c8753a6f 100644 --- a/lib/igt_core.c +++ b/lib/igt_core.c @@ -235,12 +235,12 @@ * An example configuration follows: * * |[ - * # The common configuration secton follows. + * # The common configuration secton follows. * [Common] * FrameDumpPath=/tmp # The path to dump frames that fail comparison checks * - * # The following section is used for configuring the Device Under Test. - * # It is not mandatory and allows overriding default values. + * # The following section is used for configuring the Device Under Test. + * # It is not mandatory and allows overriding default values. * [DUT] * SuspendResumeDelay=10 * ]|