Hi all,
After merging the net-next tree, today's linux-next build (htmldocs)
produced these warnings:
Documentation/networking/kapi:144: include/linux/phylink.h:110: ERROR: Unexpected indentation.
Documentation/networking/kapi:144: include/linux/phylink.h:111: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/networking/kapi:144: include/linux/phylink.h:614: WARNING: Inline literal start-string without end-string.
Documentation/networking/kapi:144: include/linux/phylink.h:644: WARNING: Inline literal start-string without end-string.
Introduced by commit
f99d471afa03 ("net: phylink: add PCS negotiation mode")
--
Cheers,
Stephen Rothwell
On Wed, 6 Sep 2023 08:55:43 +1000 Stephen Rothwell wrote:
> > Documentation/networking/kapi:144: include/linux/phylink.h:614: WARNING: Inline literal start-string without end-string.
> > Documentation/networking/kapi:144: include/linux/phylink.h:644: WARNING: Inline literal start-string without end-string.
>
> These have not :-(
Fix posted. I thought it was about phylink_mode_*() but apparently
the warnings are always reported with line num of the first line of
the paragraph, and the problem was actually in %PHYLINK_PCS_NEG_*.
Humpf.
On Mon, Sep 18, 2023 at 01:15:21PM +1000, Stephen Rothwell wrote:
> Hi all,
>
> After merging the net-next tree, today's linux-next build (htmldocs)
> produced these warnings:
>
> Documentation/driver-api/dpll.rst:427: ERROR: Error in "code-block" directive:
> maximum 1 argument(s) allowed, 18 supplied.
>
> .. code-block:: c
> static const struct dpll_device_ops dpll_ops = {
> .lock_status_get = ptp_ocp_dpll_lock_status_get,
> .mode_get = ptp_ocp_dpll_mode_get,
> .mode_supported = ptp_ocp_dpll_mode_supported,
> };
>
> static const struct dpll_pin_ops dpll_pins_ops = {
> .frequency_get = ptp_ocp_dpll_frequency_get,
> .frequency_set = ptp_ocp_dpll_frequency_set,
> .direction_get = ptp_ocp_dpll_direction_get,
> .direction_set = ptp_ocp_dpll_direction_set,
> .state_on_dpll_get = ptp_ocp_dpll_state_get,
> };
> Documentation/driver-api/dpll.rst:444: ERROR: Error in "code-block" directive:
> maximum 1 argument(s) allowed, 21 supplied.
>
> .. code-block:: c
> clkid = pci_get_dsn(pdev);
> bp->dpll = dpll_device_get(clkid, 0, THIS_MODULE);
> if (IS_ERR(bp->dpll)) {
> err = PTR_ERR(bp->dpll);
> dev_err(&pdev->dev, "dpll_device_alloc failed\n");
> goto out;
> }
>
> err = dpll_device_register(bp->dpll, DPLL_TYPE_PPS, &dpll_ops, bp);
> if (err)
> goto out;
>
> for (i = 0; i < OCP_SMA_NUM; i++) {
> bp->sma[i].dpll_pin = dpll_pin_get(clkid, i, THIS_MODULE, &bp->sma[i].dpll_prop);
> if (IS_ERR(bp->sma[i].dpll_pin)) {
> err = PTR_ERR(bp->dpll);
> goto out_dpll;
> }
>
> err = dpll_pin_register(bp->dpll, bp->sma[i].dpll_pin, &dpll_pins_ops,
> &bp->sma[i]);
> if (err) {
> dpll_pin_put(bp->sma[i].dpll_pin);
> goto out_dpll;
> }
> }
> Documentation/driver-api/dpll.rst:474: ERROR: Error in "code-block" directive:
> maximum 1 argument(s) allowed, 12 supplied.
>
> .. code-block:: c
> while (i) {
> --i;
> dpll_pin_unregister(bp->dpll, bp->sma[i].dpll_pin, &dpll_pins_ops, &bp->sma[i]);
> dpll_pin_put(bp->sma[i].dpll_pin);
> }
> dpll_device_put(bp->dpll);
>
>
> Introduced by commit
>
> dbb291f19393 ("dpll: documentation on DPLL subsystem interface")
>
Oops, I forgot to review dpll series. Will fix.
Thanks for the report!
--
An old man doll... just what I always wanted! - Clara