All of lore.kernel.org
 help / color / mirror / Atom feed
From: Hans de Goede <hdegoede@redhat.com>
To: "Mark Gross" <markgross@kernel.org>,
	"Andy Shevchenko" <andy@kernel.org>,
	"Mark Pearson" <markpearson@lenovo.com>,
	"David E . Box" <david.e.box@linux.intel.com>,
	"Thomas Weißschuh" <linux@weissschuh.net>,
	"Sebastian Reichel" <sre@kernel.org>
Cc: Hans de Goede <hdegoede@redhat.com>,
	Stephen Rothwell <sfr@canb.auug.org.au>,
	platform-driver-x86@vger.kernel.org,
	linux-kernel@vger.kernel.org, linux-pm@vger.kernel.org
Subject: [PATCH 0/4] Documentation/ABI: platform/x86: Sphinx warning fixes
Date: Thu, 24 Mar 2022 17:47:33 +0100	[thread overview]
Message-ID: <20220324164737.21765-1-hdegoede@redhat.com> (raw)

Hi All,

After Stephen reported some Sphinx warnings for files under
Documentation/ABI/testing, I had to first figure out how to reproduce
these. It turns out that to regenerate the htmldocs for files under
Documentation/ABI/testing once has to run:

touch Documentation/admin-guide/abi-testing.rst && make htmldocs

This turned up warnings in multiple sysfs ABI files for platform/x86
drivers, as well as in some new functionality in sysfs-class-power,
which was merged through the platform-drivers-x86 tree.

I plan to merge this series through the platform-drivers-x86 tree and
send this out in a fixed pull-req to Linus once 5.18-rc1 is out.

Regards,

Hans

p.s.

platform-drivers-x86 authors, for future patch submissions touching
files under Documentation/ABI/testing please run:

touch Documentation/admin-guide/abi-testing.rst && make htmldocs

and make sure no warnings are introduced.


Hans de Goede (4):
  Documentation/ABI: sysfs-driver-intel_sdsi: Fix sphinx warnings
  Documentation/ABI: sysfs-class-firmware-attributes: Fix Sphinx errors
  Documentation/ABI: sysfs-class-firmware-attributes: Misc. cleanups
  Documentation/ABI: sysfs-class-power: Fix Sphinx error

 .../testing/sysfs-class-firmware-attributes   | 48 ++++++++++---------
 Documentation/ABI/testing/sysfs-class-power   |  1 +
 .../ABI/testing/sysfs-driver-intel_sdsi       | 18 +++----
 3 files changed, 37 insertions(+), 30 deletions(-)

-- 
2.35.1


             reply	other threads:[~2022-03-24 16:47 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-24 16:47 Hans de Goede [this message]
2022-03-24 16:47 ` [PATCH 1/4] Documentation/ABI: sysfs-driver-intel_sdsi: Fix sphinx warnings Hans de Goede
2022-03-24 20:06   ` David E. Box
2022-03-24 16:47 ` [PATCH 2/4] Documentation/ABI: sysfs-class-firmware-attributes: Fix Sphinx errors Hans de Goede
2022-03-24 19:30   ` [External] " Mark Pearson
2022-03-24 16:47 ` [PATCH 3/4] Documentation/ABI: sysfs-class-firmware-attributes: Misc. cleanups Hans de Goede
2022-03-24 19:31   ` [External] " Mark Pearson
2022-03-24 16:47 ` [PATCH 4/4] Documentation/ABI: sysfs-class-power: Fix Sphinx error Hans de Goede
2022-03-25 10:40   ` Hans de Goede
  -- strict thread matches above, loose matches on Subject: below --
2022-03-24 16:46 [PATCH 0/4] Documentation/ABI: platform/x86: Sphinx warning fixes Hans de Goede

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=20220324164737.21765-1-hdegoede@redhat.com \
    --to=hdegoede@redhat.com \
    --cc=andy@kernel.org \
    --cc=david.e.box@linux.intel.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=linux@weissschuh.net \
    --cc=markgross@kernel.org \
    --cc=markpearson@lenovo.com \
    --cc=platform-driver-x86@vger.kernel.org \
    --cc=sfr@canb.auug.org.au \
    --cc=sre@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.