Commit fd6d2e50 authored by Linus Torvalds's avatar Linus Torvalds
Browse files

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
parents 2391f0b4 9956cfef

Documentation/core-api/genericirq.rst

+8 −8
Original line number Diff line number Diff line
@@ -225,9 +225,9 @@ interrupts. 


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);

    :c:func:`desc->irq_data.chip->irq_unmask`;

    desc->irq_data.chip->irq_unmask();





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)::



    handle_irq_event(desc->action);

    :c:func:`desc->irq_data.chip->irq_eoi`;

    desc->irq_data.chip->irq_eoi();





Default Edge IRQ flow handler
@@ -251,15 +251,15 @@ interrupts. 
The following control flow is implemented (simplified excerpt)::



    if (desc->status & running) {

        :c:func:`desc->irq_data.chip->irq_mask_ack`;

        desc->irq_data.chip->irq_mask_ack();

        desc->status |= pending | masked;

        return;

    }

    :c:func:`desc->irq_data.chip->irq_ack`;

    desc->irq_data.chip->irq_ack();

    desc->status |= running;

    do {

        if (desc->status & masked)

            :c:func:`desc->irq_data.chip->irq_unmask`;

            desc->irq_data.chip->irq_unmask();

        desc->status &= ~pending;

        handle_irq_event(desc->action);

    } while (status & pending);
@@ -293,10 +293,10 @@ simplified version without locking. 
The following control flow is implemented (simplified excerpt)::



    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);

    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

Documentation/driver-api/dmaengine/client.rst

+1 −1
Original line number Diff line number Diff line
@@ -185,7 +185,7 @@ The details of these operations are: 
      void dma_async_issue_pending(struct dma_chan *chan);



Further APIs:

------------

-------------



1. Terminate APIs

Documentation/driver-api/pci.rst

+0 −3
Original line number Diff line number Diff line
@@ -25,9 +25,6 @@ PCI Support Library 
.. kernel-doc:: drivers/pci/irq.c

   :export:



.. kernel-doc:: drivers/pci/htirq.c

   :export:



.. kernel-doc:: drivers/pci/probe.c

   :export:

Documentation/scsi/scsi_mid_low_api.txt

+3 −3
Original line number Diff line number Diff line
@@ -319,12 +319,12 @@ struct Scsi_Host: 
        instance. If the reference count reaches 0 then the given instance

        is freed



The Scsi_device structure has had reference counting infrastructure added.

This effectively spreads the ownership of struct Scsi_device instances

The scsi_device structure has had reference counting infrastructure added.

This effectively spreads the ownership of struct scsi_device instances

across the various SCSI layers which use them. Previously such instances

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

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

use scsi_device_put() to decrement its reference count (and potentially

delete it).

scripts/kernel-doc

+1 −1
Original line number Diff line number Diff line
@@ -3248,4 +3248,4 @@ if ($verbose && $warnings) { 
  print STDERR "$warnings warnings\n";

}



exit($errors);
 
exit($output_mode eq "none" ? 0 : $errors);

CRA Git | Maintained and supported by SUSTech CRA and CCSE