github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-08-02 13:22:02 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph
Linux kernel source tree
1,275,464 Commits 1 Branch 940 Tags 24 GiB
C 96.9%
Assembly 0.9%
Rust 0.6%
Shell 0.6%
Python 0.5%
Other 0.3%
ea70a9628e
Go to file
Petr Pavlu ea70a9628e ring-buffer: Correct stale comments related to non-consuming readers 
Adjust the following code documentation:

* Kernel-doc comments for ring_buffer_read_prepare() and
  ring_buffer_read_finish() mention that recording to the ring buffer is
  disabled when the read is active. Remove mention of this restriction
  because it was already lifted in commit 1039221cc2 ("ring-buffer: Do
  not disable recording when there is an iterator").

* Function ring_buffer_read_finish() performs a self-check of the
  ring-buffer by locking cpu_buffer->reader_lock and then calling
  rb_check_pages(). The preceding comment explains that the lock is
  needed because rb_check_pages() clears the HEAD flag required by
  readers which might be running in parallel. Remove this explanation
  because commit 8843e06f67 ("ring-buffer: Handle race between
  rb_move_tail and rb_check_pages") simplified the function so it no
  longer resets the mentioned flag. Nonetheless, the lock is still
  needed because a reader swapping a page into the ring buffer can make
  the underlying doubly-linked list temporarily inconsistent.

This is a non-functional change.

Link: https://lore.kernel.org/linux-trace-kernel/20240517134008.24529-2-petr.pavlu@suse.com

Cc: Masami Hiramatsu <mhiramat@kernel.org>
Cc: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Signed-off-by: Petr Pavlu <petr.pavlu@suse.com>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
2024-05-21 19:03:35 -04:00
arch Probes updates for v6.10: 2024-05-17 18:29:30 -07:00
block SCSI misc on 20240514 2024-05-14 18:25:53 -07:00
certs This update includes the following changes: 2023-11-02 16:15:30 -10:00
crypto Hi, 2024-05-15 09:22:34 -07:00
Documentation tracing ring buffer updates for v6.10: 2024-05-17 18:40:37 -07:00
drivers Devicetree for v6.10: 2024-05-17 17:27:49 -07:00
fs tracing cleanups for v6.10: 2024-05-17 18:34:27 -07:00
include tracing ring buffer updates for v6.10: 2024-05-17 18:40:37 -07:00
init Bootconfig updates for v6.10: 2024-05-17 18:23:55 -07:00
io_uring for-6.10/io_uring-20240511 2024-05-13 12:48:06 -07:00
ipc sysctl changes for v6.10-rc1 2024-05-17 17:31:24 -07:00
kernel ring-buffer: Correct stale comments related to non-consuming readers 2024-05-21 19:03:35 -04:00
lib Probes updates for v6.10: 2024-05-17 18:29:30 -07:00
LICENSES LICENSES: Add the copyleft-next-0.3.1 license 2022-11-08 15:44:01 +01:00
mm ARM: 2024-05-15 14:46:43 -07:00
net sysctl changes for v6.10-rc1 2024-05-17 17:31:24 -07:00
rust Timers and timekeeping updates: 2024-05-14 09:27:40 -07:00
samples Networking changes for 6.10. 2024-05-14 19:42:24 -07:00
scripts Modules changes for v6.10-rc1 2024-05-15 14:05:08 -07:00
security integrity-v6.10 2024-05-15 08:43:02 -07:00
sound ALSA: hda/realtek: Drop doubly quirk entry for 103c:8a2e 2024-05-13 12:54:46 +02:00
tools user-event updates for v6.10: 2024-05-17 18:46:30 -07:00
usr Kbuild updates for v6.8 2024-01-18 17:57:07 -08:00
virt KVM x86 misc changes for 6.10: 2024-05-12 03:18:44 -04:00
.clang-format clang-format: Update with v6.7-rc4's for_each macro list 2023-12-08 23:54:38 +01:00
.cocciconfig scripts: add Linux .cocciconfig for coccinelle 2016-07-22 12:13:39 +02:00
.editorconfig Add .editorconfig file for basic formatting 2023-12-28 16:22:47 +09:00
.get_maintainer.ignore Add Jeff Kirsher to .get_maintainer.ignore 2024-03-08 11:36:54 +00:00
.gitattributes .gitattributes: set diff driver for Rust source code files 2023-05-31 17:48:25 +02:00
.gitignore kbuild: create a list of all built DTB files 2024-02-19 18:20:39 +09:00
.mailmap Another not-too-busy cycle for documentation, including: 2024-05-13 10:51:53 -07:00
.rustfmt.toml rust: add .rustfmt.toml 2022-09-28 09:02:20 +02:00
COPYING COPYING: state that all contributions really are covered by this file 2020-02-10 13:32:20 -08:00
CREDITS MAINTAINERS: Drop Gustavo Pimentel as PCI DWC Maintainer 2024-03-27 13:41:02 -05:00
Kbuild Kbuild updates for v6.1 2022-10-10 12:00:45 -07:00
Kconfig kbuild: ensure full rebuild when the compiler is updated 2020-05-12 13:28:33 +09:00
MAINTAINERS powerpc updates for 6.10 2024-05-17 09:05:46 -07:00
Makefile Linux 6.9 2024-05-12 14:12:29 -07:00
README README: Fix spelling 2024-03-18 03:36:32 -06:00

README 

Linux kernel
============

There are several guides for kernel developers and users. These guides can
be rendered in a number of formats, like HTML and PDF. Please read
Documentation/admin-guide/README.rst first.

In order to build the documentation, use ``make htmldocs`` or
``make pdfdocs``.  The formatted documentation can also be read online at:

    https://www.kernel.org/doc/html/latest/

There are various text files in the Documentation/ subdirectory,
several of them using the reStructuredText markup notation.

Please read the Documentation/process/changes.rst file, as it contains the
requirements for building and running the kernel, and information about
the problems which may result by upgrading your kernel.