Commit 4979bf86 authored by Linus Torvalds's avatar Linus Torvalds

Merge tag 'docs-6.3-fixes' of git://git.lwn.net/linux

Pull documentation fixes from Jonathan Corbet:
 "A handful of fixes and minor documentation updates"

* tag 'docs-6.3-fixes' of git://git.lwn.net/linux:
  docs: vfio: fix header path
  docs: process: typo fix
  docs/mm: hugetlbfs_reserv: fix a reference to a file that doesn't exist
  docs/mm: Physical Memory: fix a reference to a file that doesn't exist
  docs: rebasing-and-merging: Drop wrong statement about git
  docs: programming-language: add Rust programming language section
  docs: programming-language: remove mention of the Intel compiler
  docs: Correct missing "d_" prefix for dentry_operations member d_weak_revalidate
  sched/doc: supplement CPU capacity with RISC-V
parents fc89d7fb d7ba3657
...@@ -242,7 +242,7 @@ group and can access them as follows:: ...@@ -242,7 +242,7 @@ group and can access them as follows::
VFIO User API VFIO User API
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Please see include/linux/vfio.h for complete API documentation. Please see include/uapi/linux/vfio.h for complete API documentation.
VFIO bus driver API VFIO bus driver API
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
......
...@@ -1222,7 +1222,7 @@ defined: ...@@ -1222,7 +1222,7 @@ defined:
return return
-ECHILD and it will be called again in ref-walk mode. -ECHILD and it will be called again in ref-walk mode.
``_weak_revalidate`` ``d_weak_revalidate``
called when the VFS needs to revalidate a "jumped" dentry. This called when the VFS needs to revalidate a "jumped" dentry. This
is called when a path-walk ends at dentry that was not acquired is called when a path-walk ends at dentry that was not acquired
by doing a lookup in the parent directory. This includes "/", by doing a lookup in the parent directory. This includes "/",
......
...@@ -213,11 +213,7 @@ point rather than some random spot. If your upstream-bound branch has ...@@ -213,11 +213,7 @@ point rather than some random spot. If your upstream-bound branch has
emptied entirely into the mainline during the merge window, you can pull it emptied entirely into the mainline during the merge window, you can pull it
forward with a command like:: forward with a command like::
git merge v5.2-rc1^0 git merge --ff-only v5.2-rc1
The "^0" will cause Git to do a fast-forward merge (which should be
possible in this situation), thus avoiding the addition of a spurious merge
commit.
The guidelines laid out above are just that: guidelines. There will always The guidelines laid out above are just that: guidelines. There will always
be situations that call out for a different solution, and these guidelines be situations that call out for a different solution, and these guidelines
......
...@@ -5,10 +5,10 @@ Hugetlbfs Reservation ...@@ -5,10 +5,10 @@ Hugetlbfs Reservation
Overview Overview
======== ========
Huge pages as described at Documentation/mm/hugetlbpage.rst are typically Huge pages as described at Documentation/admin-guide/mm/hugetlbpage.rst are
preallocated for application use. These huge pages are instantiated in a typically preallocated for application use. These huge pages are instantiated
task's address space at page fault time if the VMA indicates huge pages are in a task's address space at page fault time if the VMA indicates huge pages
to be used. If no huge page exists at page fault time, the task is sent are to be used. If no huge page exists at page fault time, the task is sent
a SIGBUS and often dies an unhappy death. Shortly after huge page support a SIGBUS and often dies an unhappy death. Shortly after huge page support
was added, it was determined that it would be better to detect a shortage was added, it was determined that it would be better to detect a shortage
of huge pages at mmap() time. The idea is that if there were not enough of huge pages at mmap() time. The idea is that if there were not enough
......
...@@ -66,7 +66,7 @@ one of the types described below. ...@@ -66,7 +66,7 @@ one of the types described below.
also populated on boot using one of ``kernelcore``, ``movablecore`` and also populated on boot using one of ``kernelcore``, ``movablecore`` and
``movable_node`` kernel command line parameters. See ``movable_node`` kernel command line parameters. See
Documentation/mm/page_migration.rst and Documentation/mm/page_migration.rst and
Documentation/admin-guide/mm/memory_hotplug.rst for additional details. Documentation/admin-guide/mm/memory-hotplug.rst for additional details.
* ``ZONE_DEVICE`` represents memory residing on devices such as PMEM and GPU. * ``ZONE_DEVICE`` represents memory residing on devices such as PMEM and GPU.
It has different characteristics than RAM zone types and it exists to provide It has different characteristics than RAM zone types and it exists to provide
......
...@@ -12,10 +12,6 @@ under ``-std=gnu11`` [gcc-c-dialect-options]_: the GNU dialect of ISO C11. ...@@ -12,10 +12,6 @@ under ``-std=gnu11`` [gcc-c-dialect-options]_: the GNU dialect of ISO C11.
This dialect contains many extensions to the language [gnu-extensions]_, This dialect contains many extensions to the language [gnu-extensions]_,
and many of them are used within the kernel as a matter of course. and many of them are used within the kernel as a matter of course.
There is some support for compiling the kernel with ``icc`` [icc]_ for several
of the architectures, although at the time of writing it is not completed,
requiring third-party patches.
Attributes Attributes
---------- ----------
...@@ -35,12 +31,28 @@ in order to feature detect which ones can be used and/or to shorten the code. ...@@ -35,12 +31,28 @@ in order to feature detect which ones can be used and/or to shorten the code.
Please refer to ``include/linux/compiler_attributes.h`` for more information. Please refer to ``include/linux/compiler_attributes.h`` for more information.
Rust
----
The kernel has experimental support for the Rust programming language
[rust-language]_ under ``CONFIG_RUST``. It is compiled with ``rustc`` [rustc]_
under ``--edition=2021`` [rust-editions]_. Editions are a way to introduce
small changes to the language that are not backwards compatible.
On top of that, some unstable features [rust-unstable-features]_ are used in
the kernel. Unstable features may change in the future, thus it is an important
goal to reach a point where only stable features are used.
Please refer to Documentation/rust/index.rst for more information.
.. [c-language] http://www.open-std.org/jtc1/sc22/wg14/www/standards .. [c-language] http://www.open-std.org/jtc1/sc22/wg14/www/standards
.. [gcc] https://gcc.gnu.org .. [gcc] https://gcc.gnu.org
.. [clang] https://clang.llvm.org .. [clang] https://clang.llvm.org
.. [icc] https://software.intel.com/en-us/c-compilers
.. [gcc-c-dialect-options] https://gcc.gnu.org/onlinedocs/gcc/C-Dialect-Options.html .. [gcc-c-dialect-options] https://gcc.gnu.org/onlinedocs/gcc/C-Dialect-Options.html
.. [gnu-extensions] https://gcc.gnu.org/onlinedocs/gcc/C-Extensions.html .. [gnu-extensions] https://gcc.gnu.org/onlinedocs/gcc/C-Extensions.html
.. [gcc-attribute-syntax] https://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html .. [gcc-attribute-syntax] https://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html
.. [n2049] http://www.open-std.org/jtc1/sc22/wg14/www/docs/n2049.pdf .. [n2049] http://www.open-std.org/jtc1/sc22/wg14/www/docs/n2049.pdf
.. [rust-language] https://www.rust-lang.org
.. [rustc] https://doc.rust-lang.org/rustc/
.. [rust-editions] https://doc.rust-lang.org/edition-guide/editions/
.. [rust-unstable-features] https://github.com/Rust-for-Linux/linux/issues/2
...@@ -320,7 +320,7 @@ for their time. Code review is a tiring and time-consuming process, and ...@@ -320,7 +320,7 @@ for their time. Code review is a tiring and time-consuming process, and
reviewers sometimes get grumpy. Even in that case, though, respond reviewers sometimes get grumpy. Even in that case, though, respond
politely and address the problems they have pointed out. When sending a next politely and address the problems they have pointed out. When sending a next
version, add a ``patch changelog`` to the cover letter or to individual patches version, add a ``patch changelog`` to the cover letter or to individual patches
explaining difference aganst previous submission (see explaining difference against previous submission (see
:ref:`the_canonical_patch_format`). :ref:`the_canonical_patch_format`).
See Documentation/process/email-clients.rst for recommendations on email See Documentation/process/email-clients.rst for recommendations on email
......
...@@ -258,7 +258,7 @@ Linux cannot currently figure out CPU capacity on its own, this information thus ...@@ -258,7 +258,7 @@ Linux cannot currently figure out CPU capacity on its own, this information thus
needs to be handed to it. Architectures must define arch_scale_cpu_capacity() needs to be handed to it. Architectures must define arch_scale_cpu_capacity()
for that purpose. for that purpose.
The arm and arm64 architectures directly map this to the arch_topology driver The arm, arm64, and RISC-V architectures directly map this to the arch_topology driver
CPU scaling data, which is derived from the capacity-dmips-mhz CPU binding; see CPU scaling data, which is derived from the capacity-dmips-mhz CPU binding; see
Documentation/devicetree/bindings/cpu/cpu-capacity.txt. Documentation/devicetree/bindings/cpu/cpu-capacity.txt.
......
...@@ -15,7 +15,8 @@ Hugetlbfs 预留 ...@@ -15,7 +15,8 @@ Hugetlbfs 预留
概述 概述
==== ====
Documentation/mm/hugetlbpage.rst 中描述的巨页通常是预先分配给应用程序使用的。如果VMA指 Documentation/admin-guide/mm/hugetlbpage.rst
中描述的巨页通常是预先分配给应用程序使用的 。如果VMA指
示要使用巨页,这些巨页会在缺页异常时被实例化到任务的地址空间。如果在缺页异常 示要使用巨页,这些巨页会在缺页异常时被实例化到任务的地址空间。如果在缺页异常
时没有巨页存在,任务就会被发送一个SIGBUS,并经常不高兴地死去。在加入巨页支 时没有巨页存在,任务就会被发送一个SIGBUS,并经常不高兴地死去。在加入巨页支
持后不久,人们决定,在mmap()时检测巨页的短缺情况会更好。这个想法是,如果 持后不久,人们决定,在mmap()时检测巨页的短缺情况会更好。这个想法是,如果
......
...@@ -231,7 +231,7 @@ CFS调度类基于实体负载跟踪机制(Per-Entity Load Tracking, PELT) ...@@ -231,7 +231,7 @@ CFS调度类基于实体负载跟踪机制(Per-Entity Load Tracking, PELT)
当前,Linux无法凭自身算出CPU算力,因此必须要有把这个信息传递给Linux的方式。每个架构必须为此 当前,Linux无法凭自身算出CPU算力,因此必须要有把这个信息传递给Linux的方式。每个架构必须为此
定义arch_scale_cpu_capacity()函数。 定义arch_scale_cpu_capacity()函数。
arm和arm64架构直接把这个信息映射到arch_topology驱动的CPU scaling数据中(译注:参考 arm、arm64和RISC-V架构直接把这个信息映射到arch_topology驱动的CPU scaling数据中(译注:参考
arch_topology.h的percpu变量cpu_scale),它是从capacity-dmips-mhz CPU binding中衍生计算 arch_topology.h的percpu变量cpu_scale),它是从capacity-dmips-mhz CPU binding中衍生计算
出来的。参见Documentation/devicetree/bindings/cpu/cpu-capacity.txt。 出来的。参见Documentation/devicetree/bindings/cpu/cpu-capacity.txt。
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment