From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 1A680C38145 for ; Tue, 6 Sep 2022 20:01:05 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230463AbiIFUBC (ORCPT ); Tue, 6 Sep 2022 16:01:02 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60296 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229823AbiIFUAa (ORCPT ); Tue, 6 Sep 2022 16:00:30 -0400 Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C0A8AB8F14 for ; Tue, 6 Sep 2022 12:56:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1662494197; x=1694030197; h=date:from:to:cc:subject:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=XJySH71IN31M6NVQ6cXy0CSzgJev/B9IC3dLWlVkEf0=; b=enqz+EZeldwIiLgiqRUyxEHdTK/rUk/z7OCvW+UwLIzMD+aZIxw+zIwV n5NPtJzAy9UFPA7NtwGoGUlxlsDEz5dHwbcmfGVU2BJn9BLlWbU5B74Xy 0mlMlrcs+kykymaJKEAntdM1X6k5h+kP7b6U2pwvNf9yeuioiDLaX6R14 lV9ssLwALPkBhqw5CQXNRPclO/4arWzoPcUuG6HrYUuu/6XsbwLaRSLIa TCRE6PJnuM1U+ftKydHmBvFCHYB4usC4wNeJFT9SNZU4jn8fnb0LqUk4j fwcxAoRna9jlc5833QAro8Rj3+MOrH6hhXyYfsU5CqtDpdlZlR5+3yDxQ Q==; X-IronPort-AV: E=McAfee;i="6500,9779,10462"; a="322869846" X-IronPort-AV: E=Sophos;i="5.93,294,1654585200"; d="scan'208";a="322869846" Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 06 Sep 2022 12:52:28 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.93,294,1654585200"; d="scan'208";a="756494906" Received: from linux.intel.com ([10.54.29.200]) by fmsmga001.fm.intel.com with ESMTP; 06 Sep 2022 12:52:28 -0700 Received: from maurocar-mobl2 (maurocar-mobl2.ger.corp.intel.com [10.252.44.186]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by linux.intel.com (Postfix) with ESMTPS id 71401580583; Tue, 6 Sep 2022 12:52:26 -0700 (PDT) Date: Tue, 6 Sep 2022 20:53:11 +0200 From: Mauro Carvalho Chehab To: Rodrigo Vivi Cc: Mauro Carvalho Chehab , David Airlie , intel-gfx@lists.freedesktop.org, linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org Subject: Re: [Intel-gfx] [PATCH v2 15/39] drm/i915: intel_dp_link_training.c: fix kernel-doc markup Message-ID: <20220906171716.15bdc72b@maurocar-mobl2> In-Reply-To: References: <0fac471eb7f6d365e9a7544071114292e08aa5ad.1657699522.git.mchehab@kernel.org> X-Mailer: Claws Mail 4.1.0 (GTK 3.24.34; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Tue, 9 Aug 2022 05:51:39 -0400 Rodrigo Vivi wrote: > On Wed, Jul 13, 2022 at 09:12:03AM +0100, Mauro Carvalho Chehab wrote: > > The return code table is not properly marked, causing warnings > > and being badly parsed by Sphinx: > > > > Documentation/gpu/i915:130: ./drivers/gpu/drm/i915/display/intel_dp_link_training.c:183: WARNING: Block quote ends without a blank line; unexpected unindent. > > Documentation/gpu/i915:130: ./drivers/gpu/drm/i915/display/intel_dp_link_training.c:186: WARNING: Definition list ends without a blank line; unexpected unindent. > > > > Use table markups to fix it. > > cool, I didn't know that Yeah, you can use almost all Sphinx tags inside a kernel-doc markup, taking some care with indents and not conflicting with the things that kernel-doc itself parses. The same is also valid for uAPI stuff inside Documentation/ABI. Regards, Mauro > > Reviewed-by: Rodrigo Vivi > > > > > > Signed-off-by: Mauro Carvalho Chehab > > --- > > > > To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. > > See [PATCH v2 00/39] at: https://lore.kernel.org/all/cover.1657699522.git.mchehab@kernel.org/ > > > > drivers/gpu/drm/i915/display/intel_dp_link_training.c | 2 ++ > > 1 file changed, 2 insertions(+) > > > > diff --git a/drivers/gpu/drm/i915/display/intel_dp_link_training.c b/drivers/gpu/drm/i915/display/intel_dp_link_training.c > > index 9feaf1a589f3..23a269fcf6ca 100644 > > --- a/drivers/gpu/drm/i915/display/intel_dp_link_training.c > > +++ b/drivers/gpu/drm/i915/display/intel_dp_link_training.c > > @@ -177,12 +177,14 @@ static int intel_dp_init_lttpr(struct intel_dp *intel_dp, const u8 dpcd[DP_RECEI > > * transparent mode link training mode. > > * > > * Returns: > > + * ==== ===================================================================== > > * >0 if LTTPRs were detected and the non-transparent LT mode was set. The > > * DPRX capabilities are read out. > > * 0 if no LTTPRs or more than 8 LTTPRs were detected or in case of a > > * detection failure and the transparent LT mode was set. The DPRX > > * capabilities are read out. > > * <0 Reading out the DPRX capabilities failed. > > + * ==== ===================================================================== > > */ > > int intel_dp_init_lttpr_and_dprx_caps(struct intel_dp *intel_dp) > > { > > -- > > 2.36.1 > >