mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: peter@bikeshed.quignogs.org.uk
To: linux-doc@vger.kernel.org, netdev@vger.kernel.org
Cc: Russell King <linux@armlinux.org.uk>,
	Andrew Lunn <andrew@lunn.ch>,
	Florian Fainelli <f.fainelli@gmail.com>,
	Heiner Kallweit <hkallweit1@gmail.com>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-kernel@vger.kernel.org,
	Peter Lister <peter@bikeshed.quignogs.org.uk>
Subject: [PATCH 0/1] Convert text to ReST list and remove doc build warnings
Date: Wed, 11 Mar 2020 19:28:22 +0000	[thread overview]
Message-ID: <20200311192823.16213-1-peter@bikeshed.quignogs.org.uk> (raw)

From: Peter Lister <peter@bikeshed.quignogs.org.uk>

A minimal patch to format a couple of multi-line return value descriptions as
ReST lists, mostly by adding blank lines to kerneldoc comments.

This is pure formatting - the actual documentation text remains unchanged.

It also removes a couple of warnings from the doc build.


Peter Lister (1):
  Reformat return value descriptions as ReST lists.

 drivers/net/phy/sfp-bus.c | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

-- 
2.24.1


             reply	other threads:[~2020-03-11 19:34 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-11 19:28 peter [this message]
2020-03-11 19:28 ` [PATCH 1/1] Reformat return value descriptions as ReST lists peter
2020-03-11 20:38   ` Russell King - ARM Linux admin
2020-03-11 22:21     ` Peter Lister
2020-03-11 22:25       ` Russell King - ARM Linux admin
2020-03-12  0:49   ` Matthew Wilcox

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=20200311192823.16213-1-peter@bikeshed.quignogs.org.uk \
    --to=peter@bikeshed.quignogs.org.uk \
    --cc=andrew@lunn.ch \
    --cc=corbet@lwn.net \
    --cc=f.fainelli@gmail.com \
    --cc=hkallweit1@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@armlinux.org.uk \
    --cc=netdev@vger.kernel.org \
    /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

all inboxes | Powered by JetHome®