Commit graph

276 commits

Author SHA1 Message Date
Ben Hutchings
deaaa915df Merge branch 'binary-indep_none_headers-common' into 'debian/latest'
chapter-common-tasks: Update linux headers common binary parameter

See merge request kernel-team/kernel-handbook!10
2025-08-27 20:47:43 +02:00
Yunseong Kim
69e40b8093 chapter-common-tasks: Update linux headers common binary parameter
Update header common package name in prompt from binary-indep_none_real
to binary-indep_none_headers-common. which can find in debian/rules.gen:

 $ grep binary-indep debian/rules.gen

Signed-off-by: Yunseong Kim <ysk@kzalloc.com>
2025-08-20 10:47:18 +00:00
Ben Hutchings
f3e3e8a893 Update "Generating orig tarball from newer upstream" for removal of genorig.py
In unstable, genorig.py has been removed since uscan can now do its
job.  Since this section is about switching to a new upstream version,
it doesn't need to cover older releases, so replace the old text about
genorig.py with instructions for using uscan.
2024-10-07 15:43:07 +02:00
Ben Hutchings
02c2edfdb3 Merge branch 'disable-debug-info' into 'master'
Disable dwarf toolchain default to really disable debug info

See merge request kernel-team/kernel-handbook!8
2024-09-22 19:01:01 +00:00
Emanuele Rocca
e5f0dc914c Disable dwarf toolchain default to really disable debug info
In order to build a kernel without debug information, it is not sufficient to
just disable DEBUG_INFO. The setting DEBUG_INFO_DWARF_TOOLCHAIN_DEFAULT needs
to be disabled as well, or `make oldconfig` will re-enable DEBUG_INFO.
2024-05-06 14:31:49 +02:00
Ben Hutchings
5b7cbe76db Merge branch 'stylish' into 'master'
Apply Debian stylesheet

See merge request kernel-team/kernel-handbook!6
2023-07-10 15:35:42 +00:00
Ben Hutchings
96484534a4 Use Debian-style navigation header and footer instead of standard DocBook ones
In the header, drop the Prev/Next links and put:

- Debian logo
- Link to kernel team page
- "Breadcrumbs" for the handbook

all with the appropriate classes for the Debian stylesheet.

In the footer:

- Keep the Prev / Home / Next links in the footer
- Since there isn't any provision in the Debian stylesheet for navigation
  across multiple chapters, add our own rules for them
- Use flexbox instead of a table for layout
2023-07-10 17:28:26 +02:00
Ben Hutchings
88fa33d2e9 Add/override some stylesheet rules to work better for DocBook-generated HTML 2023-06-26 23:25:42 +02:00
Ben Hutchings
5a73950758 stylesheet.xsl: Use namespaced tags to allow embedding un-namespaced HTML
I will need to override some rules here to fully implement the Debian
style, which requires writing (X)HTML without a namespace.  Assign
the XSL DTD to the "xsl" namespace instead of the default namespace
and change tags accordingly.
2023-06-26 23:25:42 +02:00
Ben Hutchings
1e365d377a Add and apply Debian stylesheet to HTML output
Also add the images it references, which we may want to use.
2023-06-26 23:25:34 +02:00
Ben Hutchings
03af1eb993 Just link to the GNU GPL without mentioning a filename or mailing address
This turns into a web page so it's fairly silly to suggest the other
options.  We will need to mention some other licenses and I want to
keep this brief.
2023-06-26 23:14:10 +02:00
Ben Hutchings
2dd333a7c9 Prepare to release kernel-handbook (1.0.21). 2023-05-08 23:17:30 +02:00
Ben Hutchings
61cdd96ff6 Update copyright years 2023-05-08 23:17:28 +02:00
Ben Hutchings
eddc66f72e Update instructions for building linux-headers-common package
This has been arch-independent since some time before the buster
release.
2023-05-08 23:04:28 +02:00
Ben Hutchings
3eb60d93a2 Avoid using fakeroot for rebuilding packages
For parallel builds, fakeroot limits actual concurrency a lot.  In
other cases it's still an unnecessary complication that slows things
down.

- Where appropriate, use dpkg-buildpackage instead.
- Otherwise, since src:linux has had "Rules-Requires-Root: no" since
  before buster, use DEB_RULES_REQUIRES_ROOT=no instead.  (Without
  either this or fakeroot, some debhelper commands would complain.)
- Remove fakeroot from lists of packages to be installed.
2023-05-08 23:04:28 +02:00
Ben Hutchings
6269f97f90 Add command to enable parallel builds when invoking make directly
dpkg-buildpackage will set DEB_BUILD_OPTIONS=parallel=<#cpus> but
all our example commands call debian/rules or debian/rules.gen
without using dpkg-buildpackage.

Add setting of MAKEFLAGS to the preparation section.
2023-05-08 23:04:28 +02:00
Ben Hutchings
26ffc59a4d Recommend changing ABI name before rebuilding official kernel packages
When building kernel packages with experimental changes, it is
undesirable that these packages will replace or conflict with the
current kernel packages.  Aside from any run-time bugs, if Secure Boot
is still enabled then the unsigned linux-image package will not be
bootable.  Recommend changing the ABI name so the new binary packages
are co-installable.

Give straightforward instructions for changing the ABI name for
a custom package, and given an example name of "0.local".
2023-05-08 23:04:28 +02:00
Ben Hutchings
06065d66a8 Deprecate older versions of test-patches
The current version has important bugs and limitations that make it
not nearly as easy to use as it should be.  This is now fixed in
unstable and will soon be fixed for bookworm, but older releases may
remain broken.  Expand the warning about debug info to add 2 other big
problems.
2023-05-08 23:04:24 +02:00
Ben Hutchings
b85d422032 Update instructions for disabling debug info (Closes: #1023773)
The generation of debug info and -dbg packages is now controlled
through build profiles and not through debian/config/defines.

These instructions still don't work for some versions of test-patches,
but a fix for that is in unstable and the next commit will add a
warning about the problem.
2023-05-08 23:03:20 +02:00
Ben Hutchings
243d108a54 Remove redundant "bash" from debian/bin/test-patches command lines
When test-patches was introduced, src:linux was still using source
format 1.0 which did not support setting executable bits on files in
the debian/ directory (except debian/rules).  Thus it was necessary to
include the script interpreter in these command lines.

This hasn't been the case for many years, and putting "bash" in front
will cause problems if we ever want to change the script's
interpreter.
2023-05-02 02:04:36 +02:00
Ben Hutchings
0451ed94bd Remove obsolete text referring to "patchlevels" in source packages
Before 2011, kernel udebs were built from separate source packages,
and dak didn't support Built-Using.  This meant there was no guarantee
that the exact source version for the kernel udebs in a suite would be
present in the same suite.

To ensure that we could comply with the GPL's requirements for source
availability, the kernel patch system supported multiple series files
that could each add and remove patch files.  Each Debian revision
based on the same upstream version would add a new series file, and
the source could be patched to the current or an older "patchlevel".

This became obsolete once we started building kernel udebs directly,
and the patch system has since been entirely replaced with quilt.
2023-05-02 01:24:21 +02:00
Ben Hutchings
96f779f7dc Reorder sections in "Common kernel-related tasks" to reduce confusion
The sections currently go:

- 4.1. Obtaining the Debian kernel source
- 4.2. Rebuilding official Debian kernel packages
- 4.3. Building a development version of the Debian kernel package
- 4.4. Generating orig tarball from newer upstream
- 4.5. Building a custom kernel from Debian kernel source
- 4.6. Building a custom kernel from the "pristine" kernel source
- 4.7. Out-of-tree kernel modules

It's easy to read 4.1 (which says to install linux-source-<version>)
as preparation for 4.2, which it is not.

Move sections 4.2-4.4, all relating to the official packages, after
all the other sections, which really are more likely to be common
tasks.
2023-05-02 01:24:11 +02:00
Ben Hutchings
98cb6b9320 Prepare to release kernel-handbook (1.0.20). 2022-10-03 01:56:35 +02:00
Ben Hutchings
74599e9fab Disable building of Japanese translation since it is now very incomplete
The Japanese string translations haven't been updated since 2015,
except where I updated untranslated text such as URLs.  As a result,
the Japanese version of the manual currently contains a lot of text in
English.  Until this is fixed, stop building the translated manual and
package.
2022-10-03 01:32:23 +02:00
Ben Hutchings
aee28c3af4 Makefile: Generalise translated build target
The rest of the Makefile is written to support multiple translations,
but the actual build was specific to Japanese.  Fix that.
2022-10-03 01:16:57 +02:00
Ben Hutchings
eee9e616ab Merge branch 'bug-policy' into 'master'
Revise the bug handling policy

See merge request kernel-team/kernel-handbook!3
2022-10-03 00:59:00 +02:00
Ben Hutchings
b40d7cc477 Include all authors in the contributor list
Add all Git commit author names, except for "Debian Janitor".  Also
list maks with his usual capitalisation, and sort the list in
alphabetical order.
2022-07-18 19:54:37 +02:00
Ben Hutchings
6fdfebad52 State that Salsa merge requests are now the preferred way to contribute 2022-07-18 19:42:04 +02:00
Ben Hutchings
44c3d009a0 Briefly document interaction of Secure Boot with OOT modules
Refer to the wiki for the details of how to use mokutil, rather
than duplicating that work.

Adjust some wording to account for this extra subsection.
2022-07-18 19:39:16 +02:00
Ben Hutchings
354302bddf Document DKMS as the preferred method for OOT module builds
The kernel team has been encouraging use of DKMS since the "squeeze"
release, and far more modules are now packaged for use with it.  So
list DKMS first.
2022-07-18 17:58:56 +02:00
Ben Hutchings
80829f076c Introduce subsections for OOT builds with and without module-assistant 2022-07-18 17:55:42 +02:00
Ben Hutchings
bad566e58e Document explicitly how to install module-assistant 2022-07-18 17:55:42 +02:00
Ben Hutchings
560cd670be Replace the long explanation of using module-assistant with just "m-a a-i"
Since "m-a a-i" covers the entire process, it doesn't seem very
helpful to give the long explanation as well.  We already refer to the
module-assistant documentation for details.
2022-07-18 17:55:42 +02:00
Ben Hutchings
b9b852868b Remove long-outdated reference to binary module packages in the archive
These binary module packages were built from the
linux-modules-{extra,contrib,nonfree}-2.6 source package, which were
dropped before the squeeze release(!).

nvidia-graphics-modules carried on building binary module packages
for a while, but was dropped before the stretch release.
2022-07-18 16:49:40 +02:00
Ben Hutchings
f9910e22ba Fix reference to GRUB documentation, and drop reference to LILO
We currently suggest running "man grub", but there is no general man
page for GRUB.  Suggest "info grub" instead.

LILO was removed some time ago.
2022-07-18 16:12:34 +02:00
Ben Hutchings
6004284e3c Update copyright dates 2022-07-18 16:08:34 +02:00
Ben Hutchings
eea1870b3b Capitalise "Git" outside of command and package names
Its documentation and web site refer to it as "Git" not "git".
2022-07-18 16:04:55 +02:00
Ben Hutchings
0d576fbcb8 Update link to netconsole documentation on www.kernel.org
netconsole.txt has now also been converted to reST.
2022-07-18 16:04:55 +02:00
Ben Hutchings
8bd0e84199 Merge branch 'mr1' into 'master'
Update Debian version in scope to 10

See merge request kernel-team/kernel-handbook!4
2022-07-18 14:04:02 +00:00
Tomasz Warniełło
a7a29092c6 Update Debian version in scope to 10 2022-07-18 13:20:23 +02:00
Ben Hutchings
1fda4c134d Document when and where a maintainer or submitter should report upstream
We currently only talk about asking submitters to report to an
upstream bug tracker.  However, in most cases bugs should be reported
to a mailing list, and this can be done by a maintainer.

- Generalise the "Analysis by maintainer" and "Testing by submitter"
  headings to "Responsibility of the {maintainer,submitter}"
- Add a subsection explaining how to find the right place, including
  the stable mailing list
- Add forwarding to a mailing list under "Responsibility of the
  maintainer"
- Change the text about reporting to an upstream bug tracker to
  refer to the new subsection
2022-07-15 23:07:12 +02:00
Ben Hutchings
6b8a920ce9 Mention mail archives as possible existing upstream references 2022-07-15 23:06:36 +02:00
Ben Hutchings
e8a76a357a Refer to bug trackers generally, not specifically bugzilla.kernel.org
bugzilla.kernel.org is not that popular with upstream maintainers and
shouldn't be assumed as the default bug tracker.  The MAINTAINERS file
now has B: entries identifying where bugs should be sent.
2022-07-15 22:50:08 +02:00
Ben Hutchings
c5fa5f7f1b Remove mention of maintainers analysing oopses
We hardly ever do this sort of advaned debugging, so it's not worth
mentioning here.
2022-07-15 22:23:25 +02:00
Ben Hutchings
159b968625 Remove reference to defunct kerneloops.org site 2022-07-15 22:23:17 +02:00
Ben Hutchings
fbd359033c Capitalise "Git" outside of command and package names
Its documentation and web site refer to it as "Git" not "git".
2022-07-15 21:29:57 +02:00
Ben Hutchings
0c1f5c4bc5 Update link to netconsole documentation on www.kernel.org
netconsole.txt has now also been converted to reST.
2022-07-15 21:06:13 +02:00
Ben Hutchings
40a05ab5b0 Refer to libncurses-dev instead of the now-transitional libncurses5-dev 2022-07-15 18:29:44 +02:00
Ben Hutchings
0ad7c5c817 Add new build-dependencies to bisection instructions
The current instructions, mentioning only build-essential, are long
outdated.  Add all the possible build-dependencies in the current
upstream version.  Also put the package installation in a separate
paragraph rather than combining it with fetching sources.
2022-07-15 18:24:44 +02:00
Ben Hutchings
7635642608 Remove documentation of genorig.py's obsolete, insecure tarball support
I removed support for tarballs and patches in genorig.py, because it
was no longer being tested and didn't include signature verification.
While it will still work in existing stable releases, it shouldn't be
recommended here.

While doing this, also mention that remote Git URLs will work in
bookworm onward.
2022-07-15 18:18:18 +02:00