diff options
| author | Linus Torvalds <torvalds@linux-foundation.org> | 2026-06-25 09:09:38 -0700 |
|---|---|---|
| committer | Linus Torvalds <torvalds@linux-foundation.org> | 2026-06-25 09:09:38 -0700 |
| commit | da07894d1d2ff9164cff88d15669f1e03e810b5c (patch) | |
| tree | cbe25b7bd7152f9de87b1089cc48cc55eba5c892 | |
| parent | 6cc37b86f80985774809aba82283fe0d564d870f (diff) | |
| parent | b13f724df35c4f1a69e20c965a2fc74fd2921e59 (diff) | |
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()
| -rw-r--r-- | Documentation/driver-api/uio-howto.rst | 4 | ||||
| -rw-r--r-- | Documentation/mm/index.rst | 13 | ||||
| -rw-r--r-- | Documentation/process/debugging/kgdb.rst | 2 | ||||
| -rw-r--r-- | Documentation/tools/unittest.rst | 2 | ||||
| -rw-r--r-- | Documentation/trace/events.rst | 2 | ||||
| -rw-r--r-- | MAINTAINERS | 2 | ||||
| -rw-r--r-- | tools/lib/python/kdoc/xforms_lists.py | 4 |
7 files changed, 23 insertions, 6 deletions
diff --git a/Documentation/driver-api/uio-howto.rst b/Documentation/driver-api/uio-howto.rst index 907ffa3b38f5..c08472dfbcfe 100644 --- a/Documentation/driver-api/uio-howto.rst +++ b/Documentation/driver-api/uio-howto.rst @@ -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()`, diff --git a/Documentation/mm/index.rst b/Documentation/mm/index.rst index 7aa2a8886908..13a79f5d092c 100644 --- a/Documentation/mm/index.rst +++ b/Documentation/mm/index.rst @@ -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 diff --git a/Documentation/process/debugging/kgdb.rst b/Documentation/process/debugging/kgdb.rst index c4d0a9121d52..316b1d74e9c8 100644 --- a/Documentation/process/debugging/kgdb.rst +++ b/Documentation/process/debugging/kgdb.rst @@ -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 diff --git a/Documentation/tools/unittest.rst b/Documentation/tools/unittest.rst index 14a2b2a65236..0fa8716741df 100644 --- a/Documentation/tools/unittest.rst +++ b/Documentation/tools/unittest.rst @@ -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. diff --git a/Documentation/trace/events.rst b/Documentation/trace/events.rst index 18d112963dec..581f2260614b 100644 --- a/Documentation/trace/events.rst +++ b/Documentation/trace/events.rst @@ -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 diff --git a/MAINTAINERS b/MAINTAINERS index 3eeb134cb611..bf97399d357f 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -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/ diff --git a/tools/lib/python/kdoc/xforms_lists.py b/tools/lib/python/kdoc/xforms_lists.py index aab70e5eaa6f..4251f7c6673a 100644 --- a/tools/lib/python/kdoc/xforms_lists.py +++ b/tools/lib/python/kdoc/xforms_lists.py @@ -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"(?:/\*.*\*/)"), ""), |
