Skip to content

Commit

Permalink
Merge pull request #118 from tttturtle-russ/master
Browse files Browse the repository at this point in the history
collect: kernel/admin-guide
  • Loading branch information
mudongliang committed Jul 18, 2024
2 parents f5d1fcf + 4b119b9 commit 08b5384
Show file tree
Hide file tree
Showing 71 changed files with 32,461 additions and 0 deletions.
370 changes: 370 additions & 0 deletions sources/kernel/admin-guide/README.md

Large diffs are not rendered by default.

20 changes: 20 additions & 0 deletions sources/kernel/admin-guide/abi-obsolete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
status: collected
title: "ABI obsolete symbols"
author: Linux Kernel Community
collector: tttturtle-russ
collected_date: 20240718
link: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/admin-guide/abi-obsolete.rst
---

# ABI obsolete symbols

Documents interfaces that are still remaining in the kernel, but are
marked to be removed at some later point in time.

The description of the interface will document the reason why it is
obsolete and when it can be expected to be removed.

::: {.kernel-abi rst=""}
ABI/obsolete
:::
14 changes: 14 additions & 0 deletions sources/kernel/admin-guide/abi-removed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
status: collected
title: "ABI removed symbols"
author: Linux Kernel Community
collector: tttturtle-russ
collected_date: 20240718
link: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/admin-guide/abi-removed.rst
---

# ABI removed symbols

::: {.kernel-abi rst=""}
ABI/removed
:::
23 changes: 23 additions & 0 deletions sources/kernel/admin-guide/abi-stable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
status: collected
title: "ABI stable symbols"
author: Linux Kernel Community
collector: tttturtle-russ
collected_date: 20240718
link: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/admin-guide/abi-stable.rst
---

# ABI stable symbols

Documents the interfaces that the developer has defined to be stable.

Userspace programs are free to use these interfaces with no
restrictions, and backward compatibility for them will be guaranteed for
at least 2 years.

Most interfaces (like syscalls) are expected to never change and always
be available.

::: {.kernel-abi rst=""}
ABI/stable
:::
29 changes: 29 additions & 0 deletions sources/kernel/admin-guide/abi-testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
status: collected
title: "ABI testing symbols"
author: Linux Kernel Community
collector: tttturtle-russ
collected_date: 20240718
link: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/admin-guide/abi-testing.rst
---

# ABI testing symbols

Documents interfaces that are felt to be stable, as the main development
of this interface has been completed.

The interface can be changed to add new features, but the current
interface will not break by doing this, unless grave errors or security
problems are found in them.

Userspace programs can start to rely on these interfaces, but they must
be aware of changes that can occur before these interfaces move to be
marked stable.

Programs that use these interfaces are strongly encouraged to add their
name to the description of these interfaces, so that the kernel
developers can easily notify them if any changes occur.

::: {.kernel-abi rst=""}
ABI/testing
:::
14 changes: 14 additions & 0 deletions sources/kernel/admin-guide/abi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
status: collected
title: "Linux ABI description"
author: Linux Kernel Community
collector: tttturtle-russ
collected_date: 20240718
link: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/admin-guide/abi.rst
---

# Linux ABI description

::: {.toctree maxdepth="2"}
abi-stable abi-testing abi-obsolete abi-removed
:::
Loading

0 comments on commit 08b5384

Please sign in to comment.