linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	"Rafael J. Wysocki" <rafael.j.wysocki@intel.com>,
	Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
	Bjorn Helgaas <bhelgaas@google.com>,
	David E Box <david.e.box@intel.com>,
	Fabrice Gasnier <fabrice.gasnier@st.com>,
	Hans de Goede <hdegoede@redhat.com>,
	Jerome Brunet <jbrunet@baylibre.com>,
	Pavel Hofman <pavel.hofman@ivitera.com>,
	Perry Yuan <perry_yuan@dell.com>, Rajat Jain <rajatja@google.com>,
	Rajneesh Bhardwaj <irenic.rajneesh@gmail.com>,
	Ruslan Bilovol <ruslan.bilovol@gmail.com>,
	Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>,
	Suzuki K Poulose <suzuki.poulose@arm.com>,
	Tamar Mashiah <tamar.mashiah@intel.com>,
	Tomas Winkler <tomas.winkler@intel.com>,
	platform-driver-x86@vger.kernel.org
Subject: [PATCH 0/7] Fix some issues with ABI files
Date: Mon, 27 Sep 2021 13:10:49 +0200	[thread overview]
Message-ID: <cover.1632740376.git.mchehab+huawei@kernel.org> (raw)

Hi Greg,

All patches in this series are independent each other. This series is
based on today's next (next-20210927). 

As you know, I've been busy those days adding a new feature for
get_abi.pl to identify missing documentation. While doing that, 
I noticed several issues at the ABI files on "make htmldocs".
This series address them, and it is independent from the other
patches for get_abi.pl.

Patch 1 is actually a small improvement to get_abi.pl, addressing an
issue when there are multiple definitions for the same ABI symbol.
While this is not allowed, and produce warnings, there are still
3 occurrences:

	./scripts/get_abi.pl validate
	Warning: /sys/bus/iio/devices/iio:deviceX/fault_ovuv is defined 2 times:  Documentation/ABI/testing/sysfs-bus-iio-temperature-max31856:14  Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865:0
	Warning: /sys/bus/iio/devices/iio:deviceX/in_filter_notch_center_frequency is defined 2 times:  Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865:12  Documentation/ABI/testing/sysfs-bus-iio:1911
	Warning: /sys/bus/iio/devices/triggerX/sampling_frequency is defined 2 times:  Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:92  Documentation/ABI/testing/sysfs-bus-iio:91

Once those got fixed, perhaps a future patch could make get_abi.pl to
generate an error causing the compilation to break, if WERROR is defined.

Anyway, it is better to to make the script more reliable anyway, specially 
since it is just one extra line of code.

Patches 2-7 fix random warnings introduced by new patches.

Regards,
Mauro

Mauro Carvalho Chehab (7):
  scripts: get_abi.pl: create a valid ReST with duplicated tags
  ABI: sysfs-platform-dell-privacy-wmi: correct ABI entries
  ABI: sysfs-platform-dptf: Add tables markup to a table
  ABI: configfs-usb-gadget-uac1: fix a broken table
  ABI: configfs-usb-gadget-uac2: fix a broken table
  ABI: sysfs-devices-removable: make a table valid as ReST markup
  ABI: sysfs-platform-intel-pmc: add blank lines to make it valid for
    ReST

 .../ABI/testing/configfs-usb-gadget-uac1      | 42 +++++++------
 .../ABI/testing/configfs-usb-gadget-uac2      | 43 +++++++------
 .../ABI/testing/sysfs-devices-removable       |  8 ++-
 .../testing/sysfs-platform-dell-privacy-wmi   | 60 ++++++++++++-------
 Documentation/ABI/testing/sysfs-platform-dptf |  4 ++
 .../ABI/testing/sysfs-platform-intel-pmc      |  2 +
 scripts/get_abi.pl                            |  1 +
 7 files changed, 99 insertions(+), 61 deletions(-)

-- 
2.31.1



             reply	other threads:[~2021-09-27 11:11 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-27 11:10 Mauro Carvalho Chehab [this message]
2021-09-27 11:10 ` [PATCH 1/7] scripts: get_abi.pl: create a valid ReST with duplicated tags Mauro Carvalho Chehab
2021-09-27 11:10 ` [PATCH 2/7] ABI: sysfs-platform-dell-privacy-wmi: correct ABI entries Mauro Carvalho Chehab
2021-10-11 12:52   ` Hans de Goede
2021-09-27 11:10 ` [PATCH 3/7] ABI: sysfs-platform-dptf: Add tables markup to a table Mauro Carvalho Chehab
2021-09-27 11:10 ` [PATCH 4/7] ABI: configfs-usb-gadget-uac1: fix a broken table Mauro Carvalho Chehab
2021-09-27 11:10 ` [PATCH 5/7] ABI: configfs-usb-gadget-uac2: " Mauro Carvalho Chehab
2021-09-27 11:10 ` [PATCH 6/7] ABI: sysfs-devices-removable: make a table valid as ReST markup Mauro Carvalho Chehab
2021-09-27 11:10 ` [PATCH 7/7] ABI: sysfs-platform-intel-pmc: add blank lines to make it valid for ReST Mauro Carvalho Chehab
2021-09-30  8:37   ` Winkler, Tomas
2021-10-11 12:52   ` 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=cover.1632740376.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=bhelgaas@google.com \
    --cc=corbet@lwn.net \
    --cc=david.e.box@intel.com \
    --cc=fabrice.gasnier@st.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=hdegoede@redhat.com \
    --cc=irenic.rajneesh@gmail.com \
    --cc=jbrunet@baylibre.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=pavel.hofman@ivitera.com \
    --cc=perry_yuan@dell.com \
    --cc=platform-driver-x86@vger.kernel.org \
    --cc=rafael.j.wysocki@intel.com \
    --cc=rajatja@google.com \
    --cc=ruslan.bilovol@gmail.com \
    --cc=srinivas.pandruvada@linux.intel.com \
    --cc=suzuki.poulose@arm.com \
    --cc=tamar.mashiah@intel.com \
    --cc=tomas.winkler@intel.com \
    /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;
as well as URLs for NNTP newsgroup(s).