| Message ID | 5647d7b6ffe47f53b90342e4ad881d4d4e6b005b.1657699522.git.mchehab@kernel.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | drm/i915: fix kernel-doc issues | expand |
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? 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 >
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 > >
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 *
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> --- 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(-)