Skip to content

Commit cbd6ac3

Browse files
committed
Merge tag 'docs-6.4-fixes' of git://git.lwn.net/linux
Pull documentation fixes from Jonathan Corbet: "Four straightforward documentation fixes" * tag 'docs-6.4-fixes' of git://git.lwn.net/linux: Documentation/filesystems: ramfs-rootfs-initramfs: use :Author: Documentation/filesystems: sharedsubtree: add section headings docs: quickly-build-trimmed-linux: various small fixes and improvements Documentation: use capitalization for chapters and acronyms
2 parents ac92c27 + bd415b5 commit cbd6ac3

File tree

9 files changed

+40
-32
lines changed

9 files changed

+40
-32
lines changed

Documentation/admin-guide/quickly-build-trimmed-linux.rst

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -215,12 +215,14 @@ again.
215215
reduce the compile time enormously, especially if you are running an
216216
universal kernel from a commodity Linux distribution.
217217

218-
There is a catch: the make target 'localmodconfig' will disable kernel
219-
features you have not directly or indirectly through some program utilized
220-
since you booted the system. You can reduce or nearly eliminate that risk by
221-
using tricks outlined in the reference section; for quick testing purposes
222-
that risk is often negligible, but it is an aspect you want to keep in mind
223-
in case your kernel behaves oddly.
218+
There is a catch: 'localmodconfig' is likely to disable kernel features you
219+
did not use since you booted your Linux -- like drivers for currently
220+
disconnected peripherals or a virtualization software not haven't used yet.
221+
You can reduce or nearly eliminate that risk with tricks the reference
222+
section outlines; but when building a kernel just for quick testing purposes
223+
it is often negligible if such features are missing. But you should keep that
224+
aspect in mind when using a kernel built with this make target, as it might
225+
be the reason why something you only use occasionally stopped working.
224226

225227
[:ref:`details<configuration>`]
226228

@@ -271,6 +273,9 @@ again.
271273
does nothing at all; in that case you have to manually install your kernel,
272274
as outlined in the reference section.
273275

276+
If you are running a immutable Linux distribution, check its documentation
277+
and the web to find out how to install your own kernel there.
278+
274279
[:ref:`details<install>`]
275280

276281
.. _another_sbs:
@@ -291,29 +296,29 @@ again.
291296
version you care about, as git otherwise might retrieve the entire commit
292297
history::
293298

294-
git fetch --shallow-exclude=v6.1 origin
295-
296-
If you modified the sources (for example by applying a patch), you now need
297-
to discard those modifications; that's because git otherwise will not be able
298-
to switch to the sources of another version due to potential conflicting
299-
changes::
300-
301-
git reset --hard
299+
git fetch --shallow-exclude=v6.0 origin
302300

303-
Now checkout the version you are interested in, as explained above::
301+
Now switch to the version you are interested in -- but be aware the command
302+
used here will discard any modifications you performed, as they would
303+
conflict with the sources you want to checkout::
304304

305-
git checkout --detach origin/master
305+
git checkout --force --detach origin/master
306306

307307
At this point you might want to patch the sources again or set/modify a build
308-
tag, as explained earlier; afterwards adjust the build configuration to the
309-
new codebase and build your next kernel::
308+
tag, as explained earlier. Afterwards adjust the build configuration to the
309+
new codebase using olddefconfig, which will now adjust the configuration file
310+
you prepared earlier using localmodconfig (~/linux/.config) for your next
311+
kernel::
310312

311313
# reminder: if you want to apply patches, do it at this point
312314
# reminder: you might want to update your build tag at this point
313315
make olddefconfig
316+
317+
Now build your kernel::
318+
314319
make -j $(nproc --all)
315320

316-
Install the kernel as outlined above::
321+
Afterwards install the kernel as outlined above::
317322

318323
command -v installkernel && sudo make modules_install install
319324

@@ -584,11 +589,11 @@ versions and individual commits at hand at any time::
584589
curl -L \
585590
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/clone.bundle \
586591
-o linux-stable.git.bundle
587-
git clone clone.bundle ~/linux/
592+
git clone linux-stable.git.bundle ~/linux/
588593
rm linux-stable.git.bundle
589594
cd ~/linux/
590-
git remote set-url origin
591-
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
595+
git remote set-url origin \
596+
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
592597
git fetch origin
593598
git checkout --detach origin/master
594599

Documentation/cdrom/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. SPDX-License-Identifier: GPL-2.0
22
3-
=====
4-
cdrom
5-
=====
3+
======
4+
CD-ROM
5+
======
66

77
.. toctree::
88
:maxdepth: 1

Documentation/filesystems/ramfs-rootfs-initramfs.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ Ramfs, rootfs and initramfs
66

77
October 17, 2005
88

9-
Rob Landley <rob@landley.net>
10-
=============================
9+
:Author: Rob Landley <rob@landley.net>
1110

1211
What is ramfs?
1312
--------------

Documentation/filesystems/sharedsubtree.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,7 @@ replicas continue to be exactly same.
147147

148148

149149
3) Setting mount states
150+
-----------------------
150151

151152
The mount command (util-linux package) can be used to set mount
152153
states::
@@ -612,6 +613,7 @@ replicas continue to be exactly same.
612613

613614

614615
6) Quiz
616+
-------
615617

616618
A. What is the result of the following command sequence?
617619

@@ -673,6 +675,7 @@ replicas continue to be exactly same.
673675
/mnt/1/test be?
674676

675677
7) FAQ
678+
------
676679

677680
Q1. Why is bind mount needed? How is it different from symbolic links?
678681
symbolic links can get stale if the destination mount gets
@@ -841,6 +844,7 @@ replicas continue to be exactly same.
841844
tmp usr tmp usr tmp usr
842845

843846
8) Implementation
847+
-----------------
844848

845849
8A) Datastructure
846850

Documentation/fpga/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. SPDX-License-Identifier: GPL-2.0
22
33
====
4-
fpga
4+
FPGA
55
====
66

77
.. toctree::

Documentation/locking/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. SPDX-License-Identifier: GPL-2.0
22
33
=======
4-
locking
4+
Locking
55
=======
66

77
.. toctree::

Documentation/pcmcia/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. SPDX-License-Identifier: GPL-2.0
22
33
======
4-
pcmcia
4+
PCMCIA
55
======
66

77
.. toctree::

Documentation/staging/crc32.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
=================================
2-
brief tutorial on CRC computation
2+
Brief tutorial on CRC computation
33
=================================
44

55
A CRC is a long-division remainder. You add the CRC to the message,

Documentation/timers/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. SPDX-License-Identifier: GPL-2.0
22
33
======
4-
timers
4+
Timers
55
======
66

77
.. toctree::

0 commit comments

Comments
 (0)