davidlt/kernel-ark
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

A handful of documentation fixes. The most significant of these addresses

Browse Source 
a problem with the new warning mode: it can break the build when confronted
 with a source file containing malformed kerneldoc comments.
 -----BEGIN PGP SIGNATURE-----
 
 iQIcBAABAgAGBQJaJcMHAAoJEI3ONVYwIuV6NqEQAMjstwhy1+OwvFBac492CXsN
 O/nbPbz11xtERfXOuAOQ8xAptQbvu4DzFqEQJnuNFmRFwH6fLUxfsF/2Mis6RgWX
 ky5m33uoUonNwoifW36r5Zt4BvQb2p9MUH3V9VnOSVIz9i1QAXufgqhunxe9zByA
 EpnvSRfkMtmO4ZK54oaui729D/yEszkvWJQb7xYFuRGMNfz0ENCrPq1WGYKBuVEj
 kLan49xfGb1sFSjrieNE/1I98Qea9j4HsFN4YcTaXmQalJ0OJZCBo1ybQlSR1gxM
 08lg4xEmyMjFffOh14D1p4qnRfD2h7uwG4R8JuFbSeiDm6Q2KktA+KdjTXbKjkrU
 mXpf/108tbSbDYVBzoQWkls/RgMGScH6qgfVVcrSGjsFaZyTCzxNYF0aMZ9sLSV0
 rZBYLGvKkfDPaVvtIcP/np3QR06bCZuy9/kAlIwvNSP2md34L9Wz+kmxpJQV2kqh
 HL7vnAwXtZHHzxAAtBdZtOq+bUhmEPlUeqJkM9JrI2j5YuZK68GJYZ9kQDMAaldk
 bn6+eRTSbMgEtPs0aKoy+GxUkW6RJudVa+DMDI8g4w2nQ7Bd2367FlDNw8qwTvGB
 bg4pybcNB3ZzCM+xVmqjbw+7j4kidHj0+lhcFfDfJIJ9vRmT9dIC+KrClEL5IWeR
 El2g1Xsh60fH9G1+2c0L
 =ZKWF
 -----END PGP SIGNATURE-----

Merge tag 'docs-4.15-fixes' of git://git.lwn.net/linux

Pull documentation fixes from Jonathan Corbet:
 "A handful of documentation fixes.

  The most significant of these addresses a problem with the new warning
  mode: it can break the build when confronted with a source file
  containing malformed kerneldoc comments"

* tag 'docs-4.15-fixes' of git://git.lwn.net/linux:
  Documentation: fix docs build error after source file removed
  scsi: documentation: Fix case of 'scsi_device' struct mention(s)
  genericirq.rst: Remove :c:func:`...` in code blocks
  dmaengine: doc : Fix warning "Title underline too short" while make xmldocs
  scripts/kernel-doc: Don't fail with status != 0 if error encountered with -none
This commit is contained in:
Linus Torvalds 2017-12-04 13:55:28 -08:00
commit fd6d2e506c
5 changed files with 13 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Documentation/core-api/genericirq.rst
View File

@ -225,9 +225,9 @@ interrupts.
The following control flow is implemented (simplified excerpt):: The following control flow is implemented (simplified excerpt)::
:c:func:`desc->irq_data.chip->irq_mask_ack`; desc->irq_data.chip->irq_mask_ack();
handle_irq_event(desc->action); handle_irq_event(desc->action);
:c:func:`desc->irq_data.chip->irq_unmask`; desc->irq_data.chip->irq_unmask();
Default Fast EOI IRQ flow handler Default Fast EOI IRQ flow handler
@ -239,7 +239,7 @@ which only need an EOI at the end of the handler.
The following control flow is implemented (simplified excerpt):: The following control flow is implemented (simplified excerpt)::
handle_irq_event(desc->action); handle_irq_event(desc->action);
:c:func:`desc->irq_data.chip->irq_eoi`; desc->irq_data.chip->irq_eoi();
Default Edge IRQ flow handler Default Edge IRQ flow handler
@ -251,15 +251,15 @@ interrupts.
The following control flow is implemented (simplified excerpt):: The following control flow is implemented (simplified excerpt)::
if (desc->status & running) { if (desc->status & running) {
:c:func:`desc->irq_data.chip->irq_mask_ack`; desc->irq_data.chip->irq_mask_ack();
desc->status |= pending | masked; desc->status |= pending | masked;
return; return;
} }
:c:func:`desc->irq_data.chip->irq_ack`; desc->irq_data.chip->irq_ack();
desc->status |= running; desc->status |= running;
do { do {
if (desc->status & masked) if (desc->status & masked)
:c:func:`desc->irq_data.chip->irq_unmask`; desc->irq_data.chip->irq_unmask();
desc->status &= ~pending; desc->status &= ~pending;
handle_irq_event(desc->action); handle_irq_event(desc->action);
} while (status & pending); } while (status & pending);
@ -293,10 +293,10 @@ simplified version without locking.
The following control flow is implemented (simplified excerpt):: The following control flow is implemented (simplified excerpt)::
if (desc->irq_data.chip->irq_ack) if (desc->irq_data.chip->irq_ack)
:c:func:`desc->irq_data.chip->irq_ack`; desc->irq_data.chip->irq_ack();
handle_irq_event(desc->action); handle_irq_event(desc->action);
if (desc->irq_data.chip->irq_eoi) if (desc->irq_data.chip->irq_eoi)
:c:func:`desc->irq_data.chip->irq_eoi`; desc->irq_data.chip->irq_eoi();
EOI Edge IRQ flow handler EOI Edge IRQ flow handler

2
Documentation/driver-api/dmaengine/client.rst
View File

@ -185,7 +185,7 @@ The details of these operations are:
void dma_async_issue_pending(struct dma_chan *chan); void dma_async_issue_pending(struct dma_chan *chan);
Further APIs: Further APIs:
------------ -------------
1. Terminate APIs 1. Terminate APIs

3
Documentation/driver-api/pci.rst
View File

@ -25,9 +25,6 @@ PCI Support Library
.. kernel-doc:: drivers/pci/irq.c .. kernel-doc:: drivers/pci/irq.c
:export: :export:
.. kernel-doc:: drivers/pci/htirq.c
:export:
.. kernel-doc:: drivers/pci/probe.c .. kernel-doc:: drivers/pci/probe.c
:export: :export:

6
Documentation/scsi/scsi_mid_low_api.txt
View File

@ -319,12 +319,12 @@ struct Scsi_Host:
instance. If the reference count reaches 0 then the given instance instance. If the reference count reaches 0 then the given instance
is freed is freed
The Scsi_device structure has had reference counting infrastructure added. The scsi_device structure has had reference counting infrastructure added.
This effectively spreads the ownership of struct Scsi_device instances This effectively spreads the ownership of struct scsi_device instances
across the various SCSI layers which use them. Previously such instances across the various SCSI layers which use them. Previously such instances
were exclusively owned by the mid level. See the access functions declared were exclusively owned by the mid level. See the access functions declared
towards the end of include/scsi/scsi_device.h . If an LLD wants to keep towards the end of include/scsi/scsi_device.h . If an LLD wants to keep
a copy of a pointer to a Scsi_device instance it should use scsi_device_get() a copy of a pointer to a scsi_device instance it should use scsi_device_get()
to bump its reference count. When it is finished with the pointer it can to bump its reference count. When it is finished with the pointer it can
use scsi_device_put() to decrement its reference count (and potentially use scsi_device_put() to decrement its reference count (and potentially
delete it). delete it).

2
scripts/kernel-doc
View File

@ -3248,4 +3248,4 @@ if ($verbose && $warnings) {
print STDERR "$warnings warnings\n"; print STDERR "$warnings warnings\n";
} }
exit($errors); exit($output_mode eq "none" ? 0 : $errors);