| Message ID | 0fac471eb7f6d365e9a7544071114292e08aa5ad.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: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 Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com> > > 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_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 >
On Tue, 9 Aug 2022 05:51:39 -0400 Rodrigo Vivi <rodrigo.vivi@intel.com> 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 <rodrigo.vivi@intel.com> > > > > > > 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_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 > >
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) {
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. 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_dp_link_training.c | 2 ++ 1 file changed, 2 insertions(+)