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 X-Spam-Level: X-Spam-Status: No, score=-3.7 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 59295C433ED for ; Thu, 8 Apr 2021 15:21:06 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 2756761108 for ; Thu, 8 Apr 2021 15:21:06 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231772AbhDHPVQ (ORCPT ); Thu, 8 Apr 2021 11:21:16 -0400 Received: from mga11.intel.com ([192.55.52.93]:27094 "EHLO mga11.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231765AbhDHPVQ (ORCPT ); Thu, 8 Apr 2021 11:21:16 -0400 IronPort-SDR: 7GkFQeC0e6fIB3ehObjCr06lySG6X9BKCSOsqlUTjlW3P9XVC6UVfyTDMTNtv9YVhjL8242Ypq Q70oYli78XAQ== X-IronPort-AV: E=McAfee;i="6000,8403,9948"; a="190361512" X-IronPort-AV: E=Sophos;i="5.82,206,1613462400"; d="scan'208";a="190361512" Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by fmsmga102.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 08 Apr 2021 08:21:05 -0700 IronPort-SDR: hehMe0RGXXMFw71hVQc9LJCLAVsJL/rHzwvYyTth7IUperK74tJa9PJ3/86FKrUMveYF4OBzB0 NK0ypqZMLKYA== X-IronPort-AV: E=Sophos;i="5.82,206,1613462400"; d="scan'208";a="613372126" Received: from ideak-desk.fi.intel.com ([10.237.68.141]) by fmsmga005-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 08 Apr 2021 08:21:02 -0700 Date: Thu, 8 Apr 2021 18:20:59 +0300 From: Imre Deak To: Stephen Rothwell , Jani Nikula , Joonas Lahtinen , Rodrigo Vivi , Intel Graphics , DRI , Linux Kernel Mailing List , Linux Next Mailing List Subject: Re: linux-next: build warning after merge of the drm-intel-fixes tree Message-ID: <20210408152059.GC2374391@ideak-desk.fi.intel.com> References: <20210326195838.5ad4973b@canb.auug.org.au> <20210329090117.6b224931@canb.auug.org.au> <20210329182335.GE233691@ideak-desk.fi.intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: Precedence: bulk List-ID: X-Mailing-List: linux-next@vger.kernel.org On Thu, Apr 08, 2021 at 12:38:52PM +0200, Daniel Vetter wrote: > On Mon, Mar 29, 2021 at 09:23:35PM +0300, Imre Deak wrote: > > Hi Stephen, > > > > thanks for the report. > > > > On Mon, Mar 29, 2021 at 09:01:17AM +1100, Stephen Rothwell wrote: > > > Hi all, > > > > > > On Fri, 26 Mar 2021 19:58:38 +1100 Stephen Rothwell wrote: > > > > > > > > After merging the drm-intel-fixes tree, today's linux-next build > > > > (htmldocs) produced this warning: > > > > > > > > Documentation/gpu/i915:22: /drivers/gpu/drm/i915/intel_runtime_pm.c:423: WARNING: Inline strong start-string without end-string. > > > > The problem seems to be the > > > > @ignore_usecount=true > > > > part in __intel_runtime_pm_get_if_active()'s docbook documentation. I > > can't see the problem with it, it was meant as a reference to the > > function parameter, granted I'm not sure what's the proper markup syntax > > for this. > > > > I will follow up with the following change which suppresses the warning > > and renders the html as expected unless someone can suggest a better > > way: > > > > - * If @ignore_usecount=true, a reference will be acquired even if there is no > > + * If @ignore_usecount is true, a reference will be acquired even if there is no > > Yeah you can't just use most pseudo-code in kerneldoc because it's > interpreted as raw .rst. So would need some .rst quoting of some sorts to > make it render correctly. > > Usually for pseudo-code I go with blockquotes (started with :: at the end > of the previous line, plus indenting), that gives you also a nice > fixed-width font and everything. Thanks for the info, will read up on the .rst docs and will try to check make htmldocs before sending patches. > Aside from the hyperlink stuff plain English works best in the text parts. > -Daniel > > > > > --Imre > > > > > > > > > > Introduced by commit > > > > > > > > 8840e3bd981f ("drm/i915: Fix the GT fence revocation runtime PM logic") > > > > > > This warning now exists in Linus' tree. > > > > > > -- > > > Cheers, > > > Stephen Rothwell > > > > > > -- > Daniel Vetter > Software Engineer, Intel Corporation > http://blog.ffwll.ch