Bug 255026 - many kernel configuration files link to outdated Handbook version
Summary: many kernel configuration files link to outdated Handbook version
Status: New
Alias: None
Product: Base System
Classification: Unclassified
Component: kern (show other bugs)
Version: CURRENT
Hardware: Any Any
: --- Affects Some People
Assignee: freebsd-doc (Nobody)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-04-13 08:46 UTC by Michael Büker
Modified: 2021-04-19 08:57 UTC (History)
4 users (show)

See Also:


Attachments
Patch for src/* (34.12 KB, patch)
2021-04-14 13:51 UTC, Ceri Davies
no flags Details | Diff
New patch (34.41 KB, patch)
2021-04-19 08:57 UTC, Ceri Davies
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Michael Büker 2021-04-13 08:46:50 UTC
Almost all kernel configuration files contain in their header the following Handbook link:

https://www.FreeBSD.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig-config.html

However, that links to an outdated version of the Handbook, and should be:

https://www.FreeBSD.org/doc/en/books/handbook/kernelconfig-config.html

The following 35 kernel configuration files are affected:

# grep -Rl "en_US.ISO8859-1" /usr/src/sys/*/conf/

/usr/src/sys/amd64/conf/GENERIC
/usr/src/sys/amd64/conf/GENERIC-KCSAN
/usr/src/sys/amd64/conf/MINIMAL
/usr/src/sys/arm/conf/ALPINE
/usr/src/sys/arm/conf/APALIS-IMX6
/usr/src/sys/arm/conf/ARMADAXP
/usr/src/sys/arm/conf/COLIBRI-VF50
/usr/src/sys/arm/conf/COSMIC
/usr/src/sys/arm/conf/EFIKA_MX
/usr/src/sys/arm/conf/GENERIC
/usr/src/sys/arm/conf/VERSATILEPB
/usr/src/sys/arm/conf/IMX53
/usr/src/sys/arm/conf/IMX6
/usr/src/sys/arm/conf/JETSON-TK1
/usr/src/sys/arm/conf/QUARTZ
/usr/src/sys/arm/conf/RPI-B
/usr/src/sys/arm/conf/SOCDK
/usr/src/sys/arm/conf/SOCFPGA
/usr/src/sys/arm/conf/SOCKIT
/usr/src/sys/arm/conf/SOCKIT-BERI
/usr/src/sys/arm/conf/TEGRA124
/usr/src/sys/arm/conf/VYBRID
/usr/src/sys/arm/conf/ZEDBOARD
/usr/src/sys/arm64/conf/GENERIC
/usr/src/sys/arm64/conf/GENERIC-UP
/usr/src/sys/i386/conf/GENERIC
/usr/src/sys/i386/conf/MINIMAL
/usr/src/sys/mips/conf/ERL
/usr/src/sys/mips/conf/OCTEON1
/usr/src/sys/mips/conf/XLP64
/usr/src/sys/mips/conf/XLPN32
/usr/src/sys/powerpc/conf/GENERIC
/usr/src/sys/powerpc/conf/GENERIC64
/usr/src/sys/powerpc/conf/GENERIC64LE
/usr/src/sys/riscv/conf/GENERIC
Comment 1 Ceri Davies 2021-04-14 13:51:59 UTC
Created attachment 224107 [details]
Patch for src/*

Mega patch for all of src attached.

RELNOTES_LANG in release/Makefile doesn't seem to do anything, but the removal might need testing.
Comment 2 Ed Maste freebsd_committer 2021-04-14 18:02:47 UTC
Should the new link be:

https://docs.freebsd.org/en/books/handbook/kernelconfig/
Comment 3 Graham Perrin 2021-04-14 18:14:15 UTC
8.4 at <https://docs.freebsd.org/en/books/handbook/kernelconfig-config.html> does appear to be outdated, compared to 8.4 at <https://docs.freebsd.org/en/books/handbook/kernelconfig/#kernelconfig-config>

The former refers to: 

> Section A.3, “Using Subversion”

If one begins at the FreeBSD home page, then the FreeBSD Handbook finds 'Using Subversion' at section _4_ of Appendix A, <https://docs.freebsd.org/en/books/handbook/mirrors/#svn>.
Comment 4 Michael Büker 2021-04-17 06:29:32 UTC
I concur, the correct link is:

https://docs.freebsd.org/en/books/handbook/kernelconfig/#kernelconfig-config
Comment 5 Ceri Davies 2021-04-19 08:57:12 UTC
Created attachment 224244 [details]
New patch

New patch attached.