mirror of
https://github.com/torvalds/linux.git
synced 2026-07-27 01:32:21 +02:00
A handful of late-arriving docs fixes, along with one document update
that fell through the cracks before. -----BEGIN PGP SIGNATURE----- iQFDBAABCgAtFiEEIw+MvkEiF49krdp9F0NaE2wMflgFAmo9JLAPHGNvcmJldEBs d24ubmV0AAoJEBdDWhNsDH5Y78sH/jWxQF61bEtdwa4RbO8xw/4j2HK2GPguynK+ ctdYQE0V6lLwcsPyvu5IPoHXXJ+z3RAyNkRu/n6/LTIFGQ0Z4lXOyu3fjVYhC2Tw QXVWp0G1Wb5gHVdW9g2KwXWv2U/9Z2HIftr3RlXbr+Zt8aIn+A4kqsjuQI5y7Dlu 4aTRI0xjeRhSZHUT1dwlaqV9vH3MB/lgwmnbHCKF2uxuRK3K/1HfNppnPdBkmKyA bru70pdw7PR+m87H+9sCr99T4YfrLFGRdOdM/pO+BsmmuSeC8SIWKaAHKWQJAn1A WGZdnuiZON8jV9RpwRK7BSeW/k7QxjO9TYxM96xBLQQuAo2REec= =jpJf -----END PGP SIGNATURE----- Merge tag 'docs-7.2-2' of git://git.kernel.org/pub/scm/linux/kernel/git/docs/linux Pull more documentation updates from Jonathan Corbet: "A handful of late-arriving docs fixes, along with one document update that fell through the cracks before" * tag 'docs-7.2-2' of git://git.kernel.org/pub/scm/linux/kernel/git/docs/linux: docs: tools: Fix typo 'ackward' to 'awkward' in unittest.rst kdoc: xforms: ignore special static/inline macros kdoc: xforms_lists: handle DECLARE_PER_CPU() in kernel-doc MAINTAINERS: Fix regex for kdoc docs: kgdb: Fix path of driver options Documentation: tracing: fix typo in events documentation Docs/driver-api/uio-howto: document mmap_prepare callback docs/mm: clarify that we are not looking for LLM generated content kernel-doc: xforms: support __SYSFS_FUNCTION_ALTERNATIVE()
This commit is contained in:
commit
da07894d1d
|
|
@ -246,10 +246,10 @@ the members are required, others are optional.
|
|||
hardware interrupt number. The flags given here will be used in the
|
||||
call to :c:func:`request_irq()`.
|
||||
|
||||
- ``int (*mmap)(struct uio_info *info, struct vm_area_struct *vma)``:
|
||||
- ``int (*mmap_prepare)(struct uio_info *info, struct vm_area_desc *desc)``:
|
||||
Optional. If you need a special :c:func:`mmap()`
|
||||
function, you can set it here. If this pointer is not NULL, your
|
||||
:c:func:`mmap()` will be called instead of the built-in one.
|
||||
``mmap_prepare`` will be called instead of the built-in one.
|
||||
|
||||
- ``int (*open)(struct uio_info *info, struct inode *inode)``:
|
||||
Optional. You might want to have your own :c:func:`open()`,
|
||||
|
|
|
|||
|
|
@ -7,6 +7,19 @@ of Linux. If you are looking for advice on simply allocating memory,
|
|||
see the :ref:`memory_allocation`. For controlling and tuning guides,
|
||||
see the :doc:`admin guide <../admin-guide/mm/index>`.
|
||||
|
||||
.. note::
|
||||
|
||||
Unfortunately, parts of this guide are still incomplete or missing.
|
||||
While we appreciate contributions, documentation in this area is hard
|
||||
to get right and requires a lot of attention to detail. New contributors
|
||||
should reach out to the relevant maintainers early.
|
||||
|
||||
This guide is expected to reflect reality, which requires contributors
|
||||
to have a detailed understanding. Documentation generated with LLMs
|
||||
by contributors unfamiliar with these details shifts the real work onto
|
||||
reviewers, which is why such contributions will be rejected without
|
||||
further comment.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
|
|
|
|||
|
|
@ -513,7 +513,7 @@ unregister all the kernel hook points.
|
|||
|
||||
All kgdb I/O drivers can be reconfigured at run time, if
|
||||
``CONFIG_SYSFS`` and ``CONFIG_MODULES`` are enabled, by echo'ing a new
|
||||
config string to ``/sys/module/<driver>/parameter/<option>``. The driver
|
||||
config string to ``/sys/module/<driver>/parameters/<option>``. The driver
|
||||
can be unconfigured by passing an empty string. You cannot change the
|
||||
configuration while the debugger is attached. Make sure to detach the
|
||||
debugger with the ``detach`` command prior to trying to unconfigure a
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ While the actual test implementation is usecase dependent, Python already
|
|||
provides a standard way to add unit tests by using ``import unittest``.
|
||||
|
||||
Using such class, requires setting up a test suite. Also, the default format
|
||||
is a little bit ackward. To improve it and provide a more uniform way to
|
||||
is a little bit awkward. To improve it and provide a more uniform way to
|
||||
report errors, some unittest classes and functions are defined.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1064,7 +1064,7 @@ correct command type, and a pointer to an event-specific run_command()
|
|||
callback that will be called to actually execute the event-specific
|
||||
command function.
|
||||
|
||||
Once that's done, the command string can by built up by successive
|
||||
Once that's done, the command string can be built up by successive
|
||||
calls to argument-adding functions.
|
||||
|
||||
To add a single argument, define and initialize a struct dynevent_arg
|
||||
|
|
|
|||
|
|
@ -7739,7 +7739,7 @@ S: Maintained
|
|||
P: Documentation/doc-guide/maintainer-profile.rst
|
||||
T: git git://git.lwn.net/linux.git docs-next
|
||||
F: Documentation/
|
||||
F: tools/lib/python/*
|
||||
F: tools/lib/python/
|
||||
F: tools/docs/
|
||||
F: tools/net/ynl/pyynl/lib/doc_generator.py
|
||||
X: Documentation/ABI/
|
||||
|
|
|
|||
|
|
@ -49,6 +49,7 @@ class CTransforms:
|
|||
(CMatch("DEFINE_DMA_UNMAP_ADDR"), r"dma_addr_t \1"),
|
||||
(CMatch("DEFINE_DMA_UNMAP_LEN"), r"__u32 \1"),
|
||||
(CMatch("VIRTIO_DECLARE_FEATURES"), r"union { u64 \1; u64 \1_array[VIRTIO_FEATURES_U64S]; }"),
|
||||
(CMatch("__SYSFS_FUNCTION_ALTERNATIVE"), r"union { \1+ }"),
|
||||
(CMatch("__attribute__"), ""),
|
||||
|
||||
#
|
||||
|
|
@ -102,6 +103,8 @@ class CTransforms:
|
|||
(CMatch("__no_context_analysis"), ""),
|
||||
(CMatch("__attribute_const__"), ""),
|
||||
(CMatch("__attribute__"), ""),
|
||||
(CMatch("STATIC_IFN_KUNIT"), ""),
|
||||
(CMatch("INLINE_IFN_KUNIT"), ""),
|
||||
|
||||
#
|
||||
# HACK: this is similar to process_export() hack. It is meant to
|
||||
|
|
@ -118,6 +121,7 @@ class CTransforms:
|
|||
(CMatch("__guarded_by"), ""),
|
||||
(CMatch("__pt_guarded_by"), ""),
|
||||
(CMatch("LIST_HEAD"), r"struct list_head \1"),
|
||||
(CMatch("DECLARE_PER_CPU"), r"\1 \2[PER_CPU]; }"),
|
||||
|
||||
(KernRe(r"(?://.*)$"), ""),
|
||||
(KernRe(r"(?:/\*.*\*/)"), ""),
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user