| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Message-ID: <20250829075524.45635-15-bagasdotme@gmail.com>
Date: Fri, 29 Aug 2025 14:55:24 +0700
From: Bagas Sanjaya <bagasdotme@...il.com>
To: Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
Linux Documentation <linux-doc@...r.kernel.org>,
Linux DAMON <damon@...ts.linux.dev>,
Linux Memory Management List <linux-mm@...ck.org>,
Linux Power Management <linux-pm@...r.kernel.org>,
Linux Block Devices <linux-block@...r.kernel.org>,
Linux BPF <bpf@...r.kernel.org>,
Linux Kernel Workflows <workflows@...r.kernel.org>,
Linux KASAN <kasan-dev@...glegroups.com>,
Linux Devicetree <devicetree@...r.kernel.org>,
Linux fsverity <fsverity@...ts.linux.dev>,
Linux MTD <linux-mtd@...ts.infradead.org>,
Linux DRI Development <dri-devel@...ts.freedesktop.org>,
Linux Kernel Build System <linux-lbuild@...r.kernel.org>,
Linux Networking <netdev@...r.kernel.org>,
Linux Sound <linux-sound@...r.kernel.org>
Cc: Thomas Gleixner <tglx@...utronix.de>,
Borislav Petkov <bp@...en8.de>,
Peter Zijlstra <peterz@...radead.org>,
Josh Poimboeuf <jpoimboe@...nel.org>,
Pawan Gupta <pawan.kumar.gupta@...ux.intel.com>,
Jonathan Corbet <corbet@....net>,
SeongJae Park <sj@...nel.org>,
Andrew Morton <akpm@...ux-foundation.org>,
David Hildenbrand <david@...hat.com>,
Lorenzo Stoakes <lorenzo.stoakes@...cle.com>,
"Liam R. Howlett" <Liam.Howlett@...cle.com>,
Vlastimil Babka <vbabka@...e.cz>,
Mike Rapoport <rppt@...nel.org>,
Suren Baghdasaryan <surenb@...gle.com>,
Michal Hocko <mhocko@...e.com>,
Huang Rui <ray.huang@....com>,
"Gautham R. Shenoy" <gautham.shenoy@....com>,
Mario Limonciello <mario.limonciello@....com>,
Perry Yuan <perry.yuan@....com>,
Jens Axboe <axboe@...nel.dk>,
Alexei Starovoitov <ast@...nel.org>,
Daniel Borkmann <daniel@...earbox.net>,
Andrii Nakryiko <andrii@...nel.org>,
Martin KaFai Lau <martin.lau@...ux.dev>,
Eduard Zingerman <eddyz87@...il.com>,
Song Liu <song@...nel.org>,
Yonghong Song <yonghong.song@...ux.dev>,
John Fastabend <john.fastabend@...il.com>,
KP Singh <kpsingh@...nel.org>,
Stanislav Fomichev <sdf@...ichev.me>,
Hao Luo <haoluo@...gle.com>,
Jiri Olsa <jolsa@...nel.org>,
Dwaipayan Ray <dwaipayanray1@...il.com>,
Lukas Bulwahn <lukas.bulwahn@...il.com>,
Joe Perches <joe@...ches.com>,
Andrey Ryabinin <ryabinin.a.a@...il.com>,
Alexander Potapenko <glider@...gle.com>,
Andrey Konovalov <andreyknvl@...il.com>,
Dmitry Vyukov <dvyukov@...gle.com>,
Vincenzo Frascino <vincenzo.frascino@....com>,
Rob Herring <robh@...nel.org>,
Krzysztof Kozlowski <krzk+dt@...nel.org>,
Conor Dooley <conor+dt@...nel.org>,
Eric Biggers <ebiggers@...nel.org>,
tytso@....edu,
Richard Weinberger <richard@....at>,
Zhihao Cheng <chengzhihao1@...wei.com>,
David Airlie <airlied@...il.com>,
Simona Vetter <simona@...ll.ch>,
Maarten Lankhorst <maarten.lankhorst@...ux.intel.com>,
Maxime Ripard <mripard@...nel.org>,
Thomas Zimmermann <tzimmermann@...e.de>,
Nathan Chancellor <nathan@...nel.org>,
Nicolas Schier <nicolas.schier@...ux.dev>,
Ingo Molnar <mingo@...hat.com>,
Will Deacon <will@...nel.org>,
Boqun Feng <boqun.feng@...il.com>,
Waiman Long <longman@...hat.com>,
"David S. Miller" <davem@...emloft.net>,
Eric Dumazet <edumazet@...gle.com>,
Jakub Kicinski <kuba@...nel.org>,
Paolo Abeni <pabeni@...hat.com>,
Simon Horman <horms@...nel.org>,
Shay Agroskin <shayagr@...zon.com>,
Arthur Kiyanovski <akiyano@...zon.com>,
David Arinzon <darinzon@...zon.com>,
Saeed Bishara <saeedb@...zon.com>,
Andrew Lunn <andrew@...n.ch>,
Liam Girdwood <lgirdwood@...il.com>,
Mark Brown <broonie@...nel.org>,
Jaroslav Kysela <perex@...ex.cz>,
Takashi Iwai <tiwai@...e.com>,
Alexandru Ciobotaru <alcioa@...zon.com>,
The AWS Nitro Enclaves Team <aws-nitro-enclaves-devel@...zon.com>,
Jesper Dangaard Brouer <hawk@...nel.org>,
Bagas Sanjaya <bagasdotme@...il.com>,
Laurent Pinchart <laurent.pinchart@...asonboard.com>,
Steve French <stfrench@...rosoft.com>,
Meetakshi Setiya <msetiya@...rosoft.com>,
Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
"Martin K. Petersen" <martin.petersen@...cle.com>,
Bart Van Assche <bvanassche@....org>,
Thomas Weißschuh <linux@...ssschuh.net>,
Masahiro Yamada <masahiroy@...nel.org>
Subject: [PATCH 14/14] Documentation: checkpatch: Convert kernel docs references
checkpatch documentation has pointer references to various style-related
docs. Convert them from external link to internal cross-references.
For reference to docs sections, use section names and reference
docs path as anchor text.
Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
---
Documentation/dev-tools/checkpatch.rst | 121 ++++++++++++------
.../bindings/submitting-patches.rst | 2 +
.../driver-api/driver-model/device.rst | 2 +
Documentation/filesystems/sysfs.rst | 2 +
Documentation/kbuild/reproducible-builds.rst | 2 +
Documentation/locking/lockdep-design.rst | 2 +
Documentation/process/coding-style.rst | 15 +++
Documentation/process/deprecated.rst | 4 +
Documentation/process/submitting-patches.rst | 4 +
9 files changed, 113 insertions(+), 41 deletions(-)
diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
index d5c47e560324fb..2ec288d845b81d 100644
--- a/Documentation/dev-tools/checkpatch.rst
+++ b/Documentation/dev-tools/checkpatch.rst
@@ -247,7 +247,7 @@ Allocation style
number of elements. sizeof() as the first argument is generally
wrong.
- See: https://www.kernel.org/doc/html/latest/core-api/memory-allocation.html
+ See: Documentation/core-api/memory-allocation.rst
**ALLOC_SIZEOF_STRUCT**
The allocation style is bad. In general for family of
@@ -260,13 +260,14 @@ Allocation style
p = alloc(sizeof(*p), ...)
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#allocating-memory
+ See: :ref:`"Allocating memory" section on Documentation/process/coding-style.rst
+ <memory-allocation-style>`.
**ALLOC_WITH_MULTIPLY**
Prefer kmalloc_array/kcalloc over kmalloc/kzalloc with a
sizeof multiply.
- See: https://www.kernel.org/doc/html/latest/core-api/memory-allocation.html
+ See: Documentation/core-api/memory-allocation.rst
API usage
@@ -287,7 +288,8 @@ API usage
Use WARN() and WARN_ON() instead, and handle the "impossible"
error condition as gracefully as possible.
- See: https://www.kernel.org/doc/html/latest/process/deprecated.html#bug-and-bug-on
+ See: :ref:`"BUG() and BUG_ON()" section on
+ Documentation/process/deprecated.rst <bug-macros-deprecated>`
**CONSIDER_KSTRTO**
The simple_strtol(), simple_strtoll(), simple_strtoul(), and
@@ -296,7 +298,9 @@ API usage
kstrtoll(), kstrtoul(), and kstrtoull() functions tend to be the
correct replacements.
- See: https://www.kernel.org/doc/html/latest/process/deprecated.html#simple-strtol-simple-strtoll-simple-strtoul-simple-strtoull
+ See: :ref:`"simple_strtol(), simple_strtoll(), simple_strtoul(),
+ simple_strtoull() section" on Documentation/process/deprecated.rst
+ <simple-strtol-family-deprecated>`
**CONSTANT_CONVERSION**
Use of __constant_<foo> form is discouraged for the following functions::
@@ -340,7 +344,8 @@ API usage
The full list of available RCU APIs can be viewed from the kernel docs.
- See: https://www.kernel.org/doc/html/latest/RCU/whatisRCU.html#full-list-of-rcu-apis
+ See: :ref:`"Full list of RCU APIs" section on
+ Documentation/RCU/whatisRCU.rst <8_whatisRCU>`
**DEVICE_ATTR_FUNCTIONS**
The function names used in DEVICE_ATTR is unusual.
@@ -354,7 +359,8 @@ API usage
The function names should preferably follow the above pattern.
- See: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes
+ See: :ref:`"Attributes" section on
+ Documentation/driver-api/driver-model/device.rst <device-attributes>`
**DEVICE_ATTR_RO**
The DEVICE_ATTR_RO(name) helper macro can be used instead of
@@ -363,7 +369,8 @@ API usage
Note that the macro automatically appends _show to the named
attribute variable of the device for the show method.
- See: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes
+ See: :ref:`"Attributes" section on
+ Documentation/driver-api/driver-model/device.rst <device-attributes>`
**DEVICE_ATTR_RW**
The DEVICE_ATTR_RW(name) helper macro can be used instead of
@@ -372,7 +379,8 @@ API usage
Note that the macro automatically appends _show and _store to the
named attribute variable of the device for the show and store methods.
- See: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes
+ See: :ref:`"Attributes" section on
+ Documentation/driver-api/driver-model/device.rst <device-attributes>`
**DEVICE_ATTR_WO**
The DEVICE_AATR_WO(name) helper macro can be used instead of
@@ -381,7 +389,8 @@ API usage
Note that the macro automatically appends _store to the
named attribute variable of the device for the store method.
- See: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes
+ See: :ref:`"Attributes" section on
+ Documentation/driver-api/driver-model/device.rst <device-attributes>`
**DUPLICATED_SYSCTL_CONST**
Commit d91bff3011cf ("proc/sysctl: add shared variables for range
@@ -443,7 +452,8 @@ API usage
lockdep_assert_held() annotations should be preferred over
assertions based on spin_is_locked()
- See: https://www.kernel.org/doc/html/latest/locking/lockdep-design.html#annotations
+ See: :ref:`"Annotations" section on
+ Documentation/locking/lockdep-design.rst <lockdep-annotations>`
**UAPI_INCLUDE**
No #include statements in include/uapi should use a uapi/ path.
@@ -472,13 +482,15 @@ Comments
* for files in net/ and drivers/net/
*/
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#commenting
+ See: :ref:`Commenting section on Documentation/process/coding-style.rst
+ <comments-style>`
**C99_COMMENTS**
C99 style single line comments (//) should not be used.
Prefer the block comment style instead.
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#commenting
+ See: :ref:`Commenting section on Documentation/process/coding-style.rst
+ <comments-style>`
**DATA_RACE**
Applications of data_race() should have a comment so as to document the
@@ -512,7 +524,8 @@ Commit message
The signed-off-by line does not fall in line with the standards
specified by the community.
- See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#developer-s-certificate-of-origin-1-1
+ See: :ref:`Developer's Certificate of Origin 1.1 text on
+ Documentation/process/submitting-patches.rst <dco-text>`
**BAD_STABLE_ADDRESS_STYLE**
The email format for stable is incorrect.
@@ -534,14 +547,16 @@ Commit message
The patch is missing a commit description. A brief
description of the changes made by the patch should be added.
- See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
+ See: :ref:`"Describe your changes" section on
+ Documentation/process/submitting-patches.rst <describe_changes>`
**EMAIL_SUBJECT**
Naming the tool that found the issue is not very useful in the
subject line. A good subject line summarizes the change that
the patch brings.
- See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
+ See: :ref:`"Describe your changes" section on
+ Documentation/process/submitting-patches.rst <describe_changes>`
**FROM_SIGN_OFF_MISMATCH**
The author's email does not match with that in the Signed-off-by:
@@ -560,7 +575,8 @@ Commit message
line should be added according to Developer's certificate of
Origin.
- See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin
+ See: :ref:`"Sign your work - the Developer's Certificate of Origin"
+ section on Documentation/process/submitting-patches.rst <dco-signoff>`
**NO_AUTHOR_SIGN_OFF**
The author of the patch has not signed off the patch. It is
@@ -569,7 +585,8 @@ Commit message
written it or otherwise has the rights to pass it on as an open
source patch.
- See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin
+ See: :ref:`"Sign your work - the Developer's Certificate of Origin"
+ section on Documentation/process/submitting-patches.rst <dco-signoff>`
**DIFF_IN_COMMIT_MSG**
Avoid having diff content in commit message.
@@ -599,14 +616,16 @@ Commit message
platform_set_drvdata(), but left the variable "dev" unused,
delete it.
- See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
+ See: :ref:`"Describe your changes" section on
+ Documentation/process/submitting-patches.rst <describe_changes>`
**BAD_FIXES_TAG**
The Fixes: tag is malformed or does not follow the community conventions.
This can occur if the tag have been split into multiple lines (e.g., when
pasted in an email program with word wrapping enabled).
- See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
+ See: :ref:`"Describe your changes" section on
+ Documentation/process/submitting-patches.rst <describe_changes>`
Comparison style
@@ -646,7 +665,8 @@ Indentation and Line Breaks
Outside of comments, documentation and Kconfig,
spaces are never used for indentation.
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#indentation
+ See: :ref:`"Indentation" section on Documentation/process/coding-style.rst
+ <indentation-style>`
**DEEP_INDENTATION**
Indentation with 6 or more tabs usually indicate overly indented
@@ -678,7 +698,8 @@ Indentation and Line Breaks
break;
}
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#indentation
+ See: :ref:`"Indentation" section on Documentation/process/coding-style.rst
+ <indentation-style>`
**LONG_LINE**
The line has exceeded the specified maximum length.
@@ -690,21 +711,24 @@ Indentation and Line Breaks
limit to 100 columns. This is not a hard limit either and it's
preferable to stay within 80 columns whenever possible.
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-strings
+ See: :ref:`"Breaking long lines and strings" section on
+ Documentation/process/coding-style.rst <long-line-break>`
**LONG_LINE_STRING**
A string starts before but extends beyond the maximum line length.
To use a different maximum line length, the --max-line-length=n option
may be added while invoking checkpatch.
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-strings
+ See: :ref:`"Breaking long lines and strings" section on
+ Documentation/process/coding-style.rst <long-line-break>`
**LONG_LINE_COMMENT**
A comment starts before but extends beyond the maximum line length.
To use a different maximum line length, the --max-line-length=n option
may be added while invoking checkpatch.
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-strings
+ See: :ref:`"Breaking long lines and strings" section on
+ Documentation/process/coding-style.rst <long-line-break>`
**SPLIT_STRING**
Quoted strings that appear as messages in userspace and can be
@@ -803,7 +827,8 @@ Macros, Attributes and Symbols
and enables warnings if they are used as they can lead to
non-deterministic builds.
- See: https://www.kernel.org/doc/html/latest/kbuild/reproducible-builds.html#timestamps
+ See: :ref:`"Timestamps" section on
+ Documentation/kbuild/reproducible-builds.rst <kernel-timestamps>`
**DEFINE_ARCH_HAS**
The ARCH_HAS_xyz and ARCH_HAVE_xyz patterns are wrong.
@@ -868,7 +893,8 @@ Macros, Attributes and Symbols
do_this(b, c); \
} while (0)
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#macros-enums-and-rtl
+ See: :ref:`"Macros, Enums and RTL" section on
+ Documentation/process/coding-style.rst <macros-style>`
**PREFER_FALLTHROUGH**
Use the `fallthrough;` pseudo keyword instead of
@@ -907,7 +933,8 @@ Macros, Attributes and Symbols
WARNING: Argument 'a' is not used in function-like macro.
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#macros-enums-and-rtl
+ See: :ref:`"Macros, Enums and RTL" section on
+ Documentation/process/coding-style.rst <macros-style>`
**SINGLE_STATEMENT_DO_WHILE_MACRO**
For the multi-statement macros, it is necessary to use the do-while
@@ -931,7 +958,8 @@ Functions and Variables
**CAMELCASE**
Avoid CamelCase Identifiers.
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#naming
+ See: :ref:`"Naming" section on Documentation/process/coding-style.rst
+ <naming-convention>`
**CONST_CONST**
Using `const <type> const *` is generally meant to be
@@ -1018,7 +1046,8 @@ Permissions
Typically only three permissions are used - 0644 (RW), 0444 (RO)
and 0200 (WO).
- See: https://www.kernel.org/doc/html/latest/filesystems/sysfs.html#attributes
+ See: :ref:`"Attributes" section on Documentation/filesystems/sysfs.rst
+ <sysfs-attributes>`
**EXECUTE_PERMISSIONS**
There is no reason for source files to be executable. The executable
@@ -1074,7 +1103,8 @@ Spacing and Brackets
body of function
}
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces
+ See: :ref:`"Placing Braces and Spaces" section on
+ Documentation/process/coding-style.rst <braces-placement>`
**BRACKET_SPACE**
Whitespace before opening bracket '[' is prohibited.
@@ -1105,20 +1135,23 @@ Spacing and Brackets
**ELSE_AFTER_BRACE**
`else {` should follow the closing block `}` on the same line.
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces
+ See: :ref:`"Placing Braces and Spaces" section on
+ Documentation/process/coding-style.rst <braces-placement>`
**LINE_SPACING**
Vertical space is wasted given the limited number of lines an
editor window can display when multiple blank lines are used.
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#spaces
+ See: :ref:`"Spaces" subsection on Documentation/process/coding-style.rst
+ <spaces-usage>`
**OPEN_BRACE**
The opening brace should be following the function definitions on the
next line. For any non-functional block it should be on the same line
as the last construct.
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces
+ See: :ref:`"Placing Braces and Spaces" section on
+ Documentation/process/coding-style.rst <braces-placement>`
**POINTER_LOCATION**
When using pointer data or a function that returns a pointer type,
@@ -1130,19 +1163,22 @@ Spacing and Brackets
unsigned long long memparse(char *ptr, char **retptr);
char *match_strdup(substring_t *s);
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#spaces
+ See: :ref:`"Spaces" subsection on Documentation/process/coding-style.rst
+ <spaces-usage>`
**SPACING**
Whitespace style used in the kernel sources is described in kernel docs.
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#spaces
+ See: :ref:`"Spaces" subsection on Documentation/process/coding-style.rst
+ <spaces-usage>`
**TRAILING_WHITESPACE**
Trailing whitespace should always be removed.
Some editors highlight the trailing whitespace and cause visual
distractions when editing files.
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#spaces
+ See: :ref:`"Spaces" subsection on Documentation/process/coding-style.rst
+ <spaces-usage>`
**UNNECESSARY_PARENTHESES**
Parentheses are not required in the following cases:
@@ -1182,7 +1218,8 @@ Spacing and Brackets
...
} while(something);
- See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces
+ See: :ref:`"Placing Braces and Spaces" section on
+ Documentation/process/coding-style.rst <braces-placement>`
Others
@@ -1216,7 +1253,7 @@ Others
DT bindings moved to a json-schema based format instead of
freeform text.
- See: https://www.kernel.org/doc/html/latest/devicetree/bindings/writing-schema.html
+ See: Documentation/devicetree/bindings/writing-schema.rst
**DT_SPLIT_BINDING_PATCH**
Devicetree bindings should be their own patch. This is because
@@ -1225,7 +1262,9 @@ Others
are applied via the same tree), and it makes for a cleaner history in the
DT only tree created with git-filter-branch.
- See: https://www.kernel.org/doc/html/latest/devicetree/bindings/submitting-patches.html#i-for-patch-submitters
+ See: :ref:`"For patch submitters" section on
+ Documentation/devicetree/bindings/submitting-patches.rst
+ <submitting-dt-patches>`
**EMBEDDED_FILENAME**
Embedding the complete filename path inside the file isn't particularly
@@ -1253,7 +1292,7 @@ Others
The Linux kernel requires the precise SPDX identifier in all source files,
and it is thoroughly documented in the kernel docs.
- See: https://www.kernel.org/doc/html/latest/process/license-rules.html
+ See: Documentation/process/license-rules.rst
**TYPO_SPELLING**
Some words may have been misspelled. Consider reviewing them.
diff --git a/Documentation/devicetree/bindings/submitting-patches.rst b/Documentation/devicetree/bindings/submitting-patches.rst
index 46d0b036c97eb5..c90b5e6d8be4ef 100644
--- a/Documentation/devicetree/bindings/submitting-patches.rst
+++ b/Documentation/devicetree/bindings/submitting-patches.rst
@@ -4,6 +4,8 @@
Submitting Devicetree (DT) binding patches
==========================================
+.. _submitting-dt-patches:
+
I. For patch submitters
=======================
diff --git a/Documentation/driver-api/driver-model/device.rst b/Documentation/driver-api/driver-model/device.rst
index 0833be568b06ca..7762d11411c5a9 100644
--- a/Documentation/driver-api/driver-model/device.rst
+++ b/Documentation/driver-api/driver-model/device.rst
@@ -35,6 +35,8 @@ A driver can access the lock in the device structure using::
void unlock_device(struct device * dev);
+.. _device-attributes:
+
Attributes
~~~~~~~~~~
diff --git a/Documentation/filesystems/sysfs.rst b/Documentation/filesystems/sysfs.rst
index 624e4f51212e63..a893e67f7fb2bb 100644
--- a/Documentation/filesystems/sysfs.rst
+++ b/Documentation/filesystems/sysfs.rst
@@ -51,6 +51,8 @@ With the current sysfs implementation the kobject reference count is
only modified directly by the function sysfs_schedule_callback().
+.. _sysfs-attributes:
+
Attributes
~~~~~~~~~~
diff --git a/Documentation/kbuild/reproducible-builds.rst b/Documentation/kbuild/reproducible-builds.rst
index f2dcc39044e66d..b0d273f871772a 100644
--- a/Documentation/kbuild/reproducible-builds.rst
+++ b/Documentation/kbuild/reproducible-builds.rst
@@ -13,6 +13,8 @@ The `Reproducible Builds project`_ has more information about this
general topic. This document covers the various reasons why building
the kernel may be unreproducible, and how to avoid them.
+.. _kernel-timestamps:
+
Timestamps
----------
diff --git a/Documentation/locking/lockdep-design.rst b/Documentation/locking/lockdep-design.rst
index 56b90eea27312e..c924dd4216c564 100644
--- a/Documentation/locking/lockdep-design.rst
+++ b/Documentation/locking/lockdep-design.rst
@@ -231,6 +231,8 @@ Note: When changing code to use the _nested() primitives, be careful and
check really thoroughly that the hierarchy is correctly mapped; otherwise
you can get false positives or false negatives.
+.. _lockdep-annotations:
+
Annotations
-----------
diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
index d1a8e5465ed956..4a17c60a9240c0 100644
--- a/Documentation/process/coding-style.rst
+++ b/Documentation/process/coding-style.rst
@@ -15,6 +15,8 @@ and NOT read it. Burn them, it's a great symbolic gesture.
Anyway, here goes:
+.. _indentation-style:
+
1) Indentation
--------------
@@ -95,6 +97,8 @@ used for indentation, and the above example is deliberately broken.
Get a decent editor and don't leave whitespace at the end of lines.
+.. _long-line-break:
+
2) Breaking long lines and strings
----------------------------------
@@ -117,6 +121,8 @@ However, never break user-visible strings such as printk messages because
that breaks the ability to grep for them.
+.. _braces-placement:
+
3) Placing Braces and Spaces
----------------------------
@@ -231,6 +237,8 @@ Also, use braces when a loop contains more than a single simple statement:
do_something();
}
+.. _spaces-usage:
+
3.1) Spaces
***********
@@ -303,6 +311,8 @@ of patches, this may make later patches in the series fail by changing their
context lines.
+.. _naming-convention:
+
4) Naming
---------
@@ -594,6 +604,7 @@ fix for this is to split it up into two error labels ``err_free_bar:`` and
Ideally you should simulate errors to test all exit paths.
+.. _comments-style:
8) Commenting
-------------
@@ -792,6 +803,8 @@ Remember: if another thread can find your data structure, and you don't
have a reference count on it, you almost certainly have a bug.
+.. _macros-style:
+
12) Macros, Enums and RTL
-------------------------
@@ -932,6 +945,8 @@ already inside a debug-related #ifdef section, printk(KERN_DEBUG ...) can be
used.
+.. _memory-allocation-style:
+
14) Allocating memory
---------------------
diff --git a/Documentation/process/deprecated.rst b/Documentation/process/deprecated.rst
index 1f7f3e6c9cda9f..8ab538034a29b9 100644
--- a/Documentation/process/deprecated.rst
+++ b/Documentation/process/deprecated.rst
@@ -29,6 +29,8 @@ a header file, it isn't the full solution. Such interfaces must either
be fully removed from the kernel, or added to this file to discourage
others from using them in the future.
+.. _bug-macros-deprecated:
+
BUG() and BUG_ON()
------------------
Use WARN() and WARN_ON() instead, and handle the "impossible"
@@ -109,6 +111,8 @@ For more details, also see array3_size() and flex_array_size(),
as well as the related check_mul_overflow(), check_add_overflow(),
check_sub_overflow(), and check_shl_overflow() family of functions.
+.. _simple-strtol-family-deprecated:
+
simple_strtol(), simple_strtoll(), simple_strtoul(), simple_strtoull()
----------------------------------------------------------------------
The simple_strtol(), simple_strtoll(),
diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index cede4e7b29af46..34a6a7c8e6f49e 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -393,6 +393,8 @@ e-mail discussions.
``git send-email`` will do this for you automatically.
+.. _dco-signoff:
+
Sign your work - the Developer's Certificate of Origin
------------------------------------------------------
@@ -406,6 +408,8 @@ patch, which certifies that you wrote it or otherwise have the right to
pass it on as an open-source patch. The rules are pretty simple: if you
can certify the below:
+.. _dco-text:
+
Developer's Certificate of Origin 1.1
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
--
An old man doll... just what I always wanted! - Clara
Powered by blists - more mailing lists