Pull documentation updates from Jonathan Corbet: "This is a fairly typical cycle for documentation. There's some welcome readability improvements for the formatted output, some LICENSES updates including the addition of the ISC license, the removal of the unloved and unmaintained 00-INDEX files, the deprecated APIs document from Kees, more MM docs from Mike Rapoport, and the usual pile of typo fixes and corrections" * tag 'docs-4.20' of git://git.lwn.net/linux: (41 commits) docs: Fix typos in histogram.rst docs: Introduce deprecated APIs list kernel-doc: fix declaration type determination doc: fix a typo in adding-syscalls.rst docs/admin-guide: memory-hotplug: remove table of contents doc: printk-formats: Remove bogus kobject references for device nodes Documentation: preempt-locking: Use better example dm flakey: Document "error_writes" feature docs/completion.txt: Fix a couple of punctuation nits LICENSES: Add ISC license text LICENSES: Add note to CDDL-1.0 license that it should not be used docs/core-api: memory-hotplug: add some details about locking internals docs/core-api: rename memory-hotplug-notifier to memory-hotplug docs: improve readability for people with poorer eyesight yama: clarify ptrace_scope=2 in Yama documentation docs/vm: split memory hotplug notifier description to Documentation/core-api docs: move memory hotplug description into admin-guide/mm doc: Fix acronym "FEKEK" in ecryptfs docs: fix some broken documentation references iommu: Fix passthrough option documentation ...
Showing the changes to include/uapi/linux (1 of 96 files). Show all
Unified · Split
| @@ -47,11 +47,11 @@ · 46 unmodified lines | ||
| 47 | 47 | #define FW_CDEV_EVENT_ISO_INTERRUPT_MULTICHANNEL 0x09 |
| 48 | 48 | |
| 49 | 49 | /** |
| 50 | − * struct fw_cdev_event_common - Common part of all fw_cdev_event_ types | |
| 50 | + * struct fw_cdev_event_common - Common part of all fw_cdev_event_* types | |
| 51 | 51 | * @closure: For arbitrary use by userspace |
| 52 | − * @type: Discriminates the fw_cdev_event_ types | |
| 52 | + * @type: Discriminates the fw_cdev_event_* types | |
| 53 | 53 | * |
| 54 | − * This struct may be used to access generic members of all fw_cdev_event_ | |
| 54 | + * This struct may be used to access generic members of all fw_cdev_event_* | |
| 55 | 55 | * types regardless of the specific type. |
| 56 | 56 | * |
| 57 | 57 | * Data passed in the @closure field for a request will be returned in the |
| @@ -123,7 +123,13 @@ struct fw_cdev_event_response { · 65 unmodified lines | ||
| 123 | 123 | |
| 124 | 124 | /** |
| 125 | 125 | * struct fw_cdev_event_request - Old version of &fw_cdev_event_request2 |
| 126 | + * @closure: See &fw_cdev_event_common; set by %FW_CDEV_IOC_ALLOCATE ioctl | |
| 126 | 127 | * @type: See &fw_cdev_event_common; always %FW_CDEV_EVENT_REQUEST |
| 128 | + * @tcode: Transaction code of the incoming request | |
| 129 | + * @offset: The offset into the 48-bit per-node address space | |
| 130 | + * @handle: Reference to the kernel-side pending request | |
| 131 | + * @length: Data length, i.e. the request's payload size in bytes | |
| 132 | + * @data: Incoming data, if any | |
| 127 | 133 | * |
| 128 | 134 | * This event is sent instead of &fw_cdev_event_request2 if the kernel or |
| 129 | 135 | * the client implements ABI version <= 3. &fw_cdev_event_request lacks |
| @@ -353,7 +359,7 @@ struct fw_cdev_event_phy_packet { · 223 unmodified lines | ||
| 353 | 359 | }; |
| 354 | 360 | |
| 355 | 361 | /** |
| 356 | − * union fw_cdev_event - Convenience union of fw_cdev_event_ types | |
| 362 | + * union fw_cdev_event - Convenience union of fw_cdev_event_* types | |
| 357 | 363 | * @common: Valid for all types |
| 358 | 364 | * @bus_reset: Valid if @common.type == %FW_CDEV_EVENT_BUS_RESET |
| 359 | 365 | * @response: Valid if @common.type == %FW_CDEV_EVENT_RESPONSE |
| @@ -735,7 +741,7 @@ struct fw_cdev_set_iso_channels { · 375 unmodified lines | ||
| 735 | 741 | * @header: Header and payload in case of a transmit context. |
| 736 | 742 | * |
| 737 | 743 | * &struct fw_cdev_iso_packet is used to describe isochronous packet queues. |
| 738 | − * Use the FW_CDEV_ISO_ macros to fill in @control. | |
| 744 | + * Use the FW_CDEV_ISO_* macros to fill in @control. | |
| 739 | 745 | * The @header array is empty in case of receive contexts. |
| 740 | 746 | * |
| 741 | 747 | * Context type %FW_CDEV_ISO_CONTEXT_TRANSMIT: |
| @@ -842,7 +848,7 @@ struct fw_cdev_queue_iso { · 100 unmodified lines | ||
| 842 | 848 | * the %FW_CDEV_ISO_SYNC bit set |
| 843 | 849 | * @tags: Tag filter bit mask. Only valid for isochronous reception. |
| 844 | 850 | * Determines the tag values for which packets will be accepted. |
| 845 | − * Use FW_CDEV_ISO_CONTEXT_MATCH_ macros to set @tags. | |
| 851 | + * Use FW_CDEV_ISO_CONTEXT_MATCH_* macros to set @tags. | |
| 846 | 852 | * @handle: Isochronous context handle within which to transmit or receive |
| 847 | 853 | */ |
| 848 | 854 | struct fw_cdev_start_iso { |
| @@ -1009,8 +1015,8 @@ struct fw_cdev_send_stream_packet { · 160 unmodified lines | ||
| 1009 | 1015 | * on the same card as this device. After transmission, an |
| 1010 | 1016 | * %FW_CDEV_EVENT_PHY_PACKET_SENT event is generated. |
| 1011 | 1017 | * |
| 1012 | − * The payload @data[] shall be specified in host byte order. Usually, | |
| 1013 | − * @data[1] needs to be the bitwise inverse of @data[0]. VersaPHY packets | |
| 1018 | + * The payload @data\[\] shall be specified in host byte order. Usually, | |
| 1019 | + * @data\[1\] needs to be the bitwise inverse of @data\[0\]. VersaPHY packets | |
| 1014 | 1020 | * are an exception to this rule. |
| 1015 | 1021 | * |
| 1016 | 1022 | * The ioctl is only permitted on device files which represent a local node. |