From: Mauro Carvalho Chehab <mauro.chehab@linux.intel.com>
To: Rodrigo Vivi <rodrigo.vivi@intel.com>
Cc: "David Airlie" <airlied@linux.ie>,
intel-gfx@lists.freedesktop.org, linux-kernel@vger.kernel.org,
dri-devel@lists.freedesktop.org,
"Juha-Pekka Heikkilä" <juha-pekka.heikkila@intel.com>,
"Mauro Carvalho Chehab" <mchehab@kernel.org>
Subject: Re: [Intel-gfx] [PATCH v2 16/39] drm/i915: intel_fb: fix a kernel-doc issue with Sphinx
Date: Tue, 6 Sep 2022 20:58:27 +0200 [thread overview]
Message-ID: <20220906205819.03709faa@maurocar-mobl2> (raw)
In-Reply-To: <YtHeySNYE+B3XJ7w@intel.com>
On Fri, 15 Jul 2022 17:40:25 -0400
Rodrigo Vivi <rodrigo.vivi@intel.com> wrote:
> On Wed, Jul 13, 2022 at 09:12:04AM +0100, Mauro Carvalho Chehab wrote:
> > We can't use %foo[<something>] as this produces a bad markup.
> > Use instead, the emphasis markup directly.
> >
> > Fix this issue:
> > Documentation/gpu/i915:136: ./drivers/gpu/drm/i915/display/intel_fb.c:280: WARNING: Inline strong start-string without end-string.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
>
> Just trying to understand as well on why in a few you had chosen ```foo```
> and here **foo**. why?
>
No particular reason. I'll use ``foo`` here too, keeping your reviewed-by.
> anyway, not a blocker:
>
> Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
>
>
>
> > ---
> >
> > 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_fb.c | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/drivers/gpu/drm/i915/display/intel_fb.c b/drivers/gpu/drm/i915/display/intel_fb.c
> > index b191915ab351..fe72c75a9c79 100644
> > --- a/drivers/gpu/drm/i915/display/intel_fb.c
> > +++ b/drivers/gpu/drm/i915/display/intel_fb.c
> > @@ -276,7 +276,7 @@ lookup_format_info(const struct drm_format_info formats[],
> > * @cmd: FB add command structure
> > *
> > * Returns:
> > - * Returns the format information for @cmd->pixel_format specific to @cmd->modifier[0],
> > + * Returns the format information for @cmd->pixel_format specific to **cmd->modifier[0]**,
> > * or %NULL if the modifier doesn't override the format.
> > */
> > const struct drm_format_info *
> > --
> > 2.36.1
> >
next prev parent reply other threads:[~2022-09-06 19:52 UTC|newest]
Thread overview: 92+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-13 8:11 [PATCH v2 00/39] drm/i915: fix kernel-doc issues Mauro Carvalho Chehab
2022-07-13 8:11 ` [PATCH v2 01/39] drm/i915/gvt: Fix kernel-doc for intel_gvt_switch_mmio() Mauro Carvalho Chehab
2022-07-13 21:54 ` Rodrigo Vivi
2022-07-13 22:00 ` Rodrigo Vivi
2022-07-14 8:50 ` [Intel-gfx] " Mauro Carvalho Chehab
2022-07-13 8:11 ` [PATCH v2 02/39] drm/i915/gvt: Fix kernel-doc for intel_vgpu_default_mmio_write Mauro Carvalho Chehab
2022-07-13 21:55 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:11 ` [PATCH v2 03/39] drm/i915/gvt: Fix kernel-doc for intel_vgpu_*_resource() Mauro Carvalho Chehab
2022-07-13 22:02 ` Rodrigo Vivi
2022-07-13 8:11 ` [PATCH v2 04/39] drm/i915: fix kernel-doc trivial warnings on i915/*.[ch] files Mauro Carvalho Chehab
2022-07-13 22:02 ` Rodrigo Vivi
2022-07-13 8:11 ` [PATCH v2 05/39] drm/i915: display: fix kernel-doc markup warnings Mauro Carvalho Chehab
2022-07-13 22:05 ` Rodrigo Vivi
2022-07-14 9:56 ` [Intel-gfx] " Mauro Carvalho Chehab
2022-07-13 8:11 ` [PATCH v2 06/39] drm/i915: gt: fix some Kernel-doc issues Mauro Carvalho Chehab
2022-07-13 22:07 ` [Intel-gfx] " Rodrigo Vivi
2022-07-14 10:01 ` Mauro Carvalho Chehab
2022-07-13 8:11 ` [PATCH v2 07/39] drm/i915: gvt: fix kernel-doc trivial warnings Mauro Carvalho Chehab
2022-07-13 22:08 ` Rodrigo Vivi
2022-07-14 4:23 ` Zhenyu Wang
2022-07-13 8:11 ` [PATCH v2 08/39] drm/i915: gem: fix some Kernel-doc issues Mauro Carvalho Chehab
2022-07-13 8:51 ` Das, Nirmoy
2022-07-13 8:11 ` [PATCH v2 09/39] drm/i915: intel_wakeref.h: fix some kernel-doc markups Mauro Carvalho Chehab
2022-07-13 22:09 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:11 ` [PATCH v2 10/39] drm/i915: i915_gem_ttm: fix a kernel-doc markup Mauro Carvalho Chehab
2022-07-13 9:02 ` Das, Nirmoy
2022-07-13 8:11 ` [PATCH v2 11/39] drm/i915: i915_gem_ttm_pm.c: fix kernel-doc markups Mauro Carvalho Chehab
2022-08-09 10:23 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 12/39] drm/i915: gem: add kernel-doc description for some function parameters Mauro Carvalho Chehab
2022-07-13 9:09 ` Das, Nirmoy
2022-07-13 8:12 ` [PATCH v2 13/39] drm/i915: i915_gpu_error.c: document dump_flags Mauro Carvalho Chehab
2022-07-15 21:38 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 14/39] drm/i915: document kernel-doc trivial issues Mauro Carvalho Chehab
2022-07-15 21:31 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 15/39] drm/i915: intel_dp_link_training.c: fix kernel-doc markup Mauro Carvalho Chehab
2022-08-09 9:51 ` [Intel-gfx] " Rodrigo Vivi
2022-09-06 18:53 ` Mauro Carvalho Chehab
2022-07-13 8:12 ` [PATCH v2 16/39] drm/i915: intel_fb: fix a kernel-doc issue with Sphinx Mauro Carvalho Chehab
2022-07-15 21:40 ` [Intel-gfx] " Rodrigo Vivi
2022-09-06 18:58 ` Mauro Carvalho Chehab [this message]
2022-07-13 8:12 ` [PATCH v2 17/39] drm/i915: skl_scaler: fix return value kernel-doc markup Mauro Carvalho Chehab
2022-07-15 21:42 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 18/39] drm/i915: intel_pm.c: fix some ascii artwork at kernel-doc Mauro Carvalho Chehab
2022-08-09 9:55 ` [Intel-gfx] " Rodrigo Vivi
2022-09-06 19:17 ` Mauro Carvalho Chehab
2022-07-13 8:12 ` [PATCH v2 19/39] drm/i915: i915_gem_region.h: fix i915_gem_apply_to_region_ops doc Mauro Carvalho Chehab
2022-08-09 9:59 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 20/39] drm/i915: i915_gem_wait.c: fix a kernel-doc markup Mauro Carvalho Chehab
2022-07-15 21:25 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 21/39] drm/i915: fix i915_gem_ttm_move.c DOC: markup Mauro Carvalho Chehab
2022-07-15 21:41 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 22/39] drm/i915: stop using kernel-doc markups for something else Mauro Carvalho Chehab
2022-07-15 21:34 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 23/39] drm/i915: dvo_ch7xxx.c: use SPDX header Mauro Carvalho Chehab
2022-07-15 21:41 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 24/39] drm/i915: dvo_sil164.c: " Mauro Carvalho Chehab
2022-07-15 21:35 ` Rodrigo Vivi
2022-07-15 22:16 ` Joe Perches
2022-07-18 11:38 ` [Intel-gfx] " Mauro Carvalho Chehab
2022-07-13 8:12 ` [PATCH v2 25/39] drm/i915: i915_vma_resource.c: fix some kernel-doc markups Mauro Carvalho Chehab
2022-07-15 21:32 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 26/39] drm/i915: i915_gem.c fix a kernel-doc issue Mauro Carvalho Chehab
2022-07-15 21:26 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 27/39] drm/i915: i915_scatterlist.h: fix some kernel-doc markups Mauro Carvalho Chehab
2022-07-15 21:33 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 28/39] drm/i915: i915_deps: use a shorter title markup Mauro Carvalho Chehab
2022-07-15 21:32 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 29/39] docs: gpu: i915.rst: display: add kernel-doc markups Mauro Carvalho Chehab
2022-08-09 9:57 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 30/39] docs: gpu: i915.rst: gt: add more " Mauro Carvalho Chehab
2022-08-09 10:01 ` [Intel-gfx] " Rodrigo Vivi
2022-09-06 19:35 ` Mauro Carvalho Chehab
2022-07-13 8:12 ` [PATCH v2 31/39] docs: gpu: i915.rst: GuC: " Mauro Carvalho Chehab
2022-08-09 10:12 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 32/39] docs: gpu: i915.rst: GVT: " Mauro Carvalho Chehab
2022-08-09 9:56 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 33/39] docs: gpu: i915.rst: PM: " Mauro Carvalho Chehab
2022-08-09 10:03 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 34/39] docs: gpu: i915.rst: GEM/TTM: " Mauro Carvalho Chehab
2022-08-09 10:02 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 35/39] docs: gpu: i915.rst: add the remaining kernel-doc markup files Mauro Carvalho Chehab
2022-08-09 10:20 ` [Intel-gfx] " Rodrigo Vivi
2022-09-06 19:43 ` Mauro Carvalho Chehab
2022-07-13 8:12 ` [PATCH v2 36/39] drm/i915 i915_gem_object_types.h: document struct i915_lut_handle Mauro Carvalho Chehab
2022-08-09 10:09 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 37/39] drm/i915: document struct drm_i915_gem_object Mauro Carvalho Chehab
2022-08-09 10:08 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 38/39] drm/i915: add descriptions for some RPM macros at intel_gt_pm.h Mauro Carvalho Chehab
2022-08-09 10:12 ` [Intel-gfx] " Rodrigo Vivi
2022-09-06 19:47 ` Mauro Carvalho Chehab
2022-07-13 8:12 ` [PATCH v2 39/39] drm/i915: add GuC functions to the documentation Mauro Carvalho Chehab
2022-08-09 10:13 ` Rodrigo Vivi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220906205819.03709faa@maurocar-mobl2 \
--to=mauro.chehab@linux.intel.com \
--cc=airlied@linux.ie \
--cc=dri-devel@lists.freedesktop.org \
--cc=intel-gfx@lists.freedesktop.org \
--cc=juha-pekka.heikkila@intel.com \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@kernel.org \
--cc=rodrigo.vivi@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).