Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
IronPort-SDR: 7GkFQeC0e6fIB3ehObjCr06lySG6X9BKCSOsqlUTjlW3P9XVC6UVfyTDMTNtv9YVhjL8242Ypq
 Q70oYli78XAQ==
IronPort-SDR: hehMe0RGXXMFw71hVQc9LJCLAVsJL/rHzwvYyTth7IUperK74tJa9PJ3/86FKrUMveYF4OBzB0
 NK0ypqZMLKYA==
Date:   Thu, 8 Apr 2021 18:20:59 +0300
From:   Imre Deak <imre.deak@intel.com>
To:     Stephen Rothwell <sfr@canb.auug.org.au>,
        Jani Nikula <jani.nikula@linux.intel.com>,
        Joonas Lahtinen <joonas.lahtinen@linux.intel.com>,
        Rodrigo Vivi <rodrigo.vivi@intel.com>,
        Intel Graphics <intel-gfx@lists.freedesktop.org>,
        DRI <dri-devel@lists.freedesktop.org>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
        Linux Next Mailing List <linux-next@vger.kernel.org>
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>
 <YG7dPD8NWbHLrFck@phenom.ffwll.local>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <YG7dPD8NWbHLrFck@phenom.ffwll.local>
Precedence: bulk

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 <sfr@canb.auug.org.au> 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