mk.conf.5: note MKCOMPAT is defaulted to "yes" for earm* too

mk.conf.5: drop duplicated "this" in sentence

Grammar fix for INSTALLBOOT_BOARDS.

Note limited platform availability for KERNEL_DIR.

man: use https URLs for www.NetBSD.org

mk.conf.5: update link to the pkgsrc documentation

branches: 1.109.2;
New make(1) variable NETBSD_REVISIONID in the NetBSD build.

This is intended to be a tree-wide revision identifier, like a commit
hash or similar. This way, in builds from non-CVS trees where
per-file $NetBSD$ revision ids aren't incremented, we can still track
some version provenance of files with ident(1).

If defined, bsd.own.mk adds a macro _NETBSD_REVISIONID to CPPFLAGS
with the stringified text of NETBSD_REVISIONID.

In turn, if _NETBSD_REVISIONID is defined in sys/cdefs.h, then
__RCSID will put the concatenation of:
- `$NetBSD: '
- the file name
- ` '
- _NETBSD_REVISIONID
- ` $'
alongside the per-file revision id passed as an argument to __RCSID.

Since this is passed through command-line arguments, it doesn't cause
make to consider any dependencies to change when the revision id
changes -- so incremental builds remain incremental. And if you
don't set it, nothing changes from the __RCSID we had before.

Currently nothing sets NETBSD_REVISIONID automatically yet -- subject
to experimentation. Could just be verbatim commit hash, or could be
longer `hg identify' output -- or, in git, with the help of tags,
could be `git describe --dirty' output like

10.99.10-2924-gd01834fb75de

(or `10.99.10-2924-gd01834fb75de-dirty' if the working tree is dirty)
for the commit at
https://mail-index.netbsd.org/source-changes/2024/05/24/msg151526.html
which is 2924 linear commits after the commit bumping sys/param.h to
10.99.10 and (in the current git conversion) had commit hash starting
with d01834fb75de. This may require some discipline around branching
and tagging but it's worth a shot -- we'll see.

Based on a patch from joerg@ a while ago.

bsd.own.mk: force MKSTRIPSYM=no if MKDEBUG=yes

Local symbols are desirable with MKDEBUG=yes, so don't strip them.
Per request from mrg@

mk.conf(5): tweak BUILDID and option. sort MKKDEBUG

Clarify BUILDID behaviour with OBJMACHINE, and remove unnecessary sentence.
Use option not flag; option may include a flag with an argument.
Sort MKKDEBUG before MKKERBEROS4.

mk.conf(5): document rump variables

Update mk.conf(5) with the rump variables from
- lib/librumpuser/README.compileopts
- sys/rump/README.compileopts

Add cross-references back to mk.conf(5) in those files.

Ensure that the Default: is listed last in a description,
for consistency with the convention in this file.

Fix previous. Patch mistakenly applied somehow...

Cite src/sys/rump/README.compileopts as a reference for MKRUMP.

mk.conf(5): more variables from BUILDING and build.sh

Add more variables from build.sh, BUILDING, and various
Makefile's documentation:
CDEXTRA CONFIGOPTS KERNARCHDIR KERNCONFDIR
KERNOBJDIR KERNSRCDIR LOCALTIME

Default sentences now consistently end with ".".
Consistency tweaks in "otherwise".
Editorial tweaks.

mk.conf(5): add remaining vars from BUILDING

Add more variables from BUILDING:
INSTALLBOOT_BOARDS INSTALLWORLDDIR NOCLEANDIR
NODISTRIBDIRS NOINCLUDES.

Add build.sh related notes (from BUILDING).

Clarify "target" as "target architecture" where appropriate
(versus a make target where that's obvious from context.)

Move all obsolete and deprecated variables to
new "OBSOLETE VARIABLES" section at the end.

Add some per-variable editorial improvements from BUILDING.

Change sub headings to headings; it's easier to read.
(I don't know why mdoc doesn't allow blank lines around .Ss)

mk.conf(5): editorial

MKDTB and MKPIE are .YorN.
MKX11=yes wants MKINET6=yes.
MKLINKLIB deserves a dash list (like bsd.README).

Expand per bsd.README: MKSTATICPIC, MKUNPRIVED,
MKX11, MKZFS, USE_LIBCSANITIZER, USE_SSP

Change the width of the variable lists to 14n (from 15n)
so that when the lists are rendered and then left aligned,
the column is 16 characters (aka 2 tabs) which makes
copypasta to bsd.README easier.

mk.conf(5): add more from BUILDING and bsd.README

Add from BUILDING or bsd.README:
BUILDINFO, BUILDSEED, EXTERNAL_TOOLCHAIN, MKCROSSGDB,
MKREPRO_TIMESTAMP, TOOLCHAIN_MISSING, X11SRCDIR

Clarify BUILDID.
Improve MKDEBUG, MKOBJ, MKX11, NETBSDSRCDIR, USETOOLS,
Consistent Note: formatting.

mk.conf: fix the year

mk.conf(5): update to reality

- Document:
MKAMDGPUFIRMWARE, MKARGON2, MKARZERO, MKBSDGREP,
MKCOMPATMODULES, MKCOMPATTESTS, MKCOMPATX11, MKCXX,
MKDEPINCLUDES, MKDTB, MKDTC, MKFIRMWARE, MKGROFF,
MKGROFFHTMLDOC, MKLIBCSANITIZER, MKLIBCXX, MKLIBSTDCXX,
MKLLVM, MKLLVMRT, MKMAKEMANDB, MKMANDOC, MKNSD,
MKRADEONFIRMWARE, MKRELRO, MKSANITIZER, MKSLJIT,
MKSTATICPIE, MKTEGRAFIRMWARE, MKTPM, MKUNBOUND,
MKXORG_SERVER, NETBSD_OFFICIAL_RELEASE,
USE_LIBCSANITIZER, USE_PIGZGZIP, USE_SANITIZER,
USE_XZ_SETS, X11MOTIFPATH
- Document obsolete/deprecated:
EXTSRCSRCDIR, MKBFD, MKCRYPTO, MKEXTSRC, MKKDEBUG,
MKKERBEROS4, MKLLD, MKLLDB, MKMCLINKER, MKPERFUSE,
MKTOOLSDEBUG, SHAREDSTRINGS, USE_COMBINE
- Fix defaults: MKLINT=no MKPICINSTALL=no USE_SKEY=no
- Expand upon defaults that are platform specific.
- Sort variable entries.
- If a NOxxx variable disables a variable, describe it.
- Layout of each variable: supported values, description,
any other variables that change this variable, optional note,
default value.
- Consistent double quotes around default strings (even paths).
- Consistent "will be" instead of "is" or "are".
- Sort order of internal macro definitions.
- Add NODEF and NOVAR macros.
- Oxford comma and semi-colons where appropriate.
- Fix mandoc -Tlint.

branches: 1.97.2;
mk.conf(5): we default to USE_SSP=yes these days.

build system: Revert all the recent additions of MK[...] knobs that
allow conditionally disabling the building of certain user space
programs in the 'base' set.

There is not enough consensus that this is the right way and a few
people had strong objections, see source-changes-d@.

mk: Add MKTIMED and MKMOUSED flags for compiling NetBSD without timed
and moused

Document MKPPP

mk: Add MKFINGER, MKTALK flags for not building
talk, talkd, finger, fingerd.

mk: Add MKNTP, MKTCPDUMP knobs.

Document MKLFS

mk.conf(5): Don't make "experimental" comment stand out.

Document some more build options. Delint.

mk: Rename the MKMBONE option to MKMROUTING for greater accuracy and
to match the related kernel config option.

mk: Allow setting MKDHCPD=no to build base without the ISC DHCP server,
useful for embedded images that don't need to act as one.

mk: Allow building base without the MBONE applications by setting
MKMBONE=no in mk.conf

Rename:
MKKDEBUG -> MKDEBUGKERNEL
MKTOOLSDEBUG -> MKDEBUGTOOLS
while keeping compatibility with the old names. Add missing documentation.
Now all debugging tunables are prefixed with MKDEBUG.

Initial attempt at documenting the KERNEL_DIR option.

XXX EXPERIMENTAL, Work-In-Progress ! XXX

Reintroduce the support of MKCATPAGES

Requested by <mrg>

Remove the support for MKCATPAGES

It was optional since 1999 and disabled by default since 2012.

Proposed on tech-userlevel@.

Document MKKDEBUG. Thanks martin for letting me know.

MKBSDTAR is yes by default

MKZFS is no longer the default on i386; it was disabled in 2015 in
bsd.own.mk 1.846.

branches: 1.78.2;
Remove superfluous Pp.

add X11MOTIFPATH and note that MKX11MOTIF needs motif installed.

branches: 1.76.10;
Remove MKCRYPTO option.

Originally, MKCRYPTO was introduced because the United States
classified cryptography as a munition and restricted its export. The
export controls were substantially relaxed fifteen years ago, and are
essentially irrelevant for software with published source code.

In the intervening time, nobody bothered to remove the option after
its motivation -- the US export restriction -- was eliminated. I'm
not aware of any other operating system that has a similar option; I
expect it is mainly out of apathy for churn that we still have it.
Today, cryptography is an essential part of modern computing -- you
can't use the internet responsibly without cryptography.

The position of the TNF board of directors is that TNF makes no
representation that MKCRYPTO=no satisfies any country's cryptography
regulations.

My personal position is that the availability of cryptography is a
basic human right; that any local laws restricting it to a privileged
few are fundamentally immoral; and that it is wrong for developers to
spend effort crippling cryptography to work around such laws.

As proposed on tech-crypto, tech-security, and tech-userlevel to no
objections:

https://mail-index.netbsd.org/tech-crypto/2017/05/06/msg000719.html
https://mail-index.netbsd.org/tech-security/2017/05/06/msg000928.html
https://mail-index.netbsd.org/tech-userlevel/2017/05/06/msg010547.html

P.S. Reviewing all the uses of MKCRYPTO in src revealed a lot of
*bad* crypto that was conditional on it, e.g. DES in telnet... That
should probably be removed too, but on the grounds that it is bad,
not on the grounds that it is (nominally) crypto.

Remove MKCRYPTO_RC5. Unconditionally include RC5 in libcrypto.so.

This option existed only because RC5 is covered by patents that, twenty
years ago, we had reason to suspect the patent holder, RSA, Inc., might
litigate. The two US patents in question are 5,724,428 and 5,835,600.

According to the USPTO Patent Term Calculator web site at
<https://www.uspto.gov/patent/laws-and-regulations/patent-term-calculator#heading-5>
(retrieved 2017-05-21), patents filed after 1995-06-07 expire twenty
years after the filing date.

number filing date
5,724,428 1995-11-01
5,835,600 1997-04-21

Thus, these patents appear to be expired.

As proposed on tech-crypto and tech-security:

https://mail-index.netbsd.org/tech-crypto/2017/05/05/msg000718.html
https://mail-index.netbsd.org/tech-security/2017/05/05/msg000927.html

Use Fl, Xr. New sentence, new line. Bump date for previous.

Introduce MKSTRIPSYM build option

If it's yes, all local symbols of shared libraries are stripped
(default). If it's no, only temporary local symbols are stripped;
for example, symbols of static functions are kept. Keeping such
symbols is useful on using DTrace for userland libraries and
getting a backtrace from a rump server loading modules (shared
libraries).

Proposed and discussed on tech-kern and tech-toolchain

The default values for MKPIC are yes and no for sh3 and m68000, respectively.
Bump date.

branches: 1.71.2; 1.71.4;
remove the xfree86 reachover makefiles and the vast majority of
the support in the rest of the source tree.

X11 sets could use some cleaning up perhaps (just deletion, as
we've never really marked the old X11R6 as obsolete for native
xorg using platforms so far either.)

Update some defaults, from Joachim Henke on netbsd-docs.

Bump date for previous.

Add MKCTF

This variable separates CTF stuffs from MKDTRACE; we can build DTrace
solely without building and using them. This allows us to use DTrace
even if CTF stuffs have problems (actually they have now).

This variable would be merged into MKDTRACE eventually, once CTF stuffs
work correctly again.

New variable MKX11MOTIF to enable building libGLw with Motif support.
Defaults to 'no'.

Use Nx, fix typo.

Add the MKKYUA knob.

MKKYUA defaults to no and will remain as such until the import is complete
and validated.

This knob does not currently have any effects on the build as nothing relies
on it yet. Upcoming imports and changes in this area will all be guarded by
this flag.

Correct a typo.

Reported by: tsutsui

Document build knobs MKBSDTAR, MKCLEANSRC, MKCLEANVERIFY, MKCOMPAT,
MKDTRACE, MKLVM, MKNPF, MKPIGZGZIP, MKREPRO, MKRUMP, MKX11FONTS and MKZFS.

Reviewed by: joerg

Fix inverted logic description for MKSTRIPIDENT.
Noted by Snader_LB on freenode IRC

branches: 1.61.2;
Bump date for previous.

more MKCRYPTO_IDEA and MKCRYPTO_MDC2 removal (resp, adjustment to IDEA and
MBC2 now always being included)
MKCRYPTO_RC5 now builds shared libs, add the missing files to sets

Use Lk macro instead of Pa when dealing with URLs, to produce links
with HTML output. And while here update some dead URL links.
First part of PR/29238.

branches: 1.58.2; 1.58.4;
Stack-smash protection is not enabled by default, at least not for
the complete source-tree.

Pointed out by <bch> on "current-users" mailing list.

branches: 1.57.2;
Until someone figures out a fix for PR 40599, document that MKKERBEROS=no
will break the system without either MKPAM=no or a customized PAM config.
As suggested by Ian D. Leroux on current-users and in PR 45263, but with
different text.

Bump date for previous.

Document MKKMOD, patch from PR 45216.

Note USE_FORT.

branches: 1.53.2;
simplify PCC inclusion; MKPCCDMDS is not really required

Typo in macro.

branches: 1.51.2;
Catch up with the changes to SSP on x86.

Multicast DNS ("Bonjour") support, based on Apple's mDNSResponder.

Fix Dd string, remove trailing whitespace.

Bump date for previous.

Rename MKBFD to MKBINUTILS and support HAVE_BINUTILS for set lists. This
makes {MK,HAVE_}BINUTILS consistent with {MK,HAVE_}{GCC,GDB}.

Allow MKBFD to defines MKBINUTILS as a backwards compatibility hook.

Update the sets lists and add conditionals for lib{bfd,opcodes}.

revert sparc back to default of XFree86 at the request of macallan.

Add support for new MAKEVERBOSE levels 3 and 4. The complete list is now:

0 Minimal output ("quiet")
1 Describe what is occurring
2 Describe what is occurring and echo the actual command
3 Ignore the effect of the "@" prefix in make commands
4 Trace shell commands using the shell's -x flag

The default remains MAKEVERBOSE=2.

Now that MKPUFFS is default, kill it as advertised.
While there, give puffs and refuse files sensible syspkg entries.

Remove LKMs and switch to the module framework, pass 1.

Proposed on tech-kern@.

- retire MKXORG from public use
- introduce X11FLAVOUR to choose src/x11 vs src/external/mit/xorg
for the X11 to build if MKX11=yes is set. it takes the values
of either Xorg or XFree86.
- default to Xorg on alpha, i386, macppc, shark, sparc and sparc64
- remove MKXORG_WITH_XSRC_XSERVER, unused and never useful

branches: 1.41.2;
Document MKSTRIPIDENT. Requested by lukem@

remove MKNVI now that Christos has obsoleted the option

Document:
MAKEVERBOSE MKATF MKGCCCMDS MKINET6 MKISCSI MKLDAP MKNVI
MKPCC MKPCCCMDS MKPIE MKPUFFS MKSTATICLIB MKX11 MKXORG
USE_HESIOD USE_INET6 USE_JEMALLOC USE_KERBEROS USE_LDAP
USE_PAM USE_SKEY USE_SSP USE_YP

Part of PR 29233

We really need one place to document this stuff, or at least the
canonical "installed" reference. Currently we have:
src/share/mk/bsd.README
src/doc/BUILDING.mdoc (for src/BUILDING)
src/share/man/man5/mk.conf.5 (for mk.conf(5))

branches: 1.38.2;
Move TNF license to 2 clause form

branches: 1.37.2; 1.37.4;
Beleatedly document the MODULAR kernel option and mk.conf's MKMODULAR.
Per hubertf@'s request.

Document CPUFLAGS, and note that CFLAGS shold not be set in mk.conf.

Remove the MKUUCP entry as uucp is no longer in src.

branches: 1.34.4;
Link to the pkgsrc guide for description of pkgsrc-specific variables.
Bump date.

branches: 1.33.2; 1.33.4;
PR/34712 -- Kibum Han -- remove mention of MKSENDMAIL as sendmail is no longer

document MKDEBUG & MKDEBUGLIB

Goodbye KerberosIV

Back out previous attempt at cleaning up the mess,
let someone else resolve this.

Requested by uwe.

Fix formatting botch.

At least try to be consistent about where to document (most...)
user-settable MKxxx and USE_xxx variables, and put them into mk.conf(5).
Sort alphabetically.

OK: christos, lukem

Remove (pf)spamd. Its right to exist in NetBSD has been questioned since it
appeared and whether it's really part of pf or not is still unclear. Looking
at the other *BSDs it seems that they have left out spamd when importing pf,
and now we do that too. Also, the name conflicted with another more popular
used tool, after the rename to pfspamd it was left with completely unusable
documentation which apparently no-one wanted to fix.

A port of the latest spamd will be imported into pkgsrc soon.

Suggested by several people, no objections on last proposal on tech-userlevel.

Fix persistent typo; slightly improve MKPAM description;
bump date for MKPAM description.

Document MKPAM, per PR 29947 by Rui Paulo.

branches: 1.24.2;
NetBSD -> .Nx, some whitespace nits.

bsd.pkg.defaults.mk was moved to defaults/mk.conf a while ago.
spotted by go@

Add MKIPFILTER; if set to no, don't build and install the ipf(4) programs,
headers and LKM.

Add MKPF; if set to no, don't build and install the pf(4) programs,
headers, LKM and spamd.

Both options default to yes, so nothing changed in the default build.

Reviewed by lukem.

Point to /usr/share/mk/bsd.README in SEE ALSO section; from Rui Paulo in PR 27997.

- Add missing .YorN
- Fix typos in previous commit

Add missing MKCVS, MKKERBEROS4, MKPOSTFIX, MKSENDMAIL, and MKUUCP.
Note that some variables are still missing, since i'm not sure how
to describe them...
Bump date.

branches: 1.18.2;
fix default location of TOOLDIR

overhaul to match reality, adding a bunch of missing MK* and other variables.

Pkgsrc->pkgsrc (Igor Sobrado, PR misc/19909)

Implement MKDYNAMICROOT, which currently defaults to "no", but will
be changed in the future to "yes".

If MKDYNAMICROOT == "no", there is no change from existing behaviour
of a static /bin and /sbin (and a few programs in elsewhere).

If MKDYNAMICROOT == "yes", the following changes occur:
in <bsd.own.mk>:
SHLIBDIR?= /lib
SHLINKDIR?= /lib
in various Makefiles, the following entry is DISABLED.
LDSTATIC?=-static
This results in all programs (except those "standalone" programs built
in sys/arch/*/stand) are linked dynamically, the shared linker is moved
from /usr/libexec to /lib (with a compat symlink), and the shared
libraries used by /bin and /sbin programs are moved from /usr/lib to
/lib (with compat symlinks).

Refer to ${PKGSRCDIR} instead of /usr/pkgsrc in the same way packages(7)
does.

Move the METALOG from ${_SRC_TOP_OBJ_} to ${DESTDIR}.

There were too many synchronisation problems with using the former;
including situations such as a "make clean" performed between two
installs to the same DESTDIR would result in a truncated METALOG and
the resultant sets would be missing stuff such as include files that
don't get reinstalled if they haven't changed, even with !UPDATE.

Document NETBSDSRCDIR & UNPRIVED.
Reword BSDOBJDIR and BSDSRCDIR descriptions.

Generate <>& symbolically. I'm avoiding .../dist/... directories for now.

Add a hyphen, and replace /usr/pkgsrc/mk/mk.conf.example with
/usr/pkgsrc/mk/bsd.pkg.defaults.mk.

Expand NLS acronym; from Jeremy C. Reed in PR misc/14577.

Typo, whitespace and punctuation fixes.

branches: 1.7.4;
UVM is no longer a controll variable.

More and more .Os cleanups. .Os is defined in the tmac.doc-common file,
so we shouldn't override it with versions in the manpages. Many more to
come.

remove pkgsrc specific documentation (we stay at mk.conf.example)

Remove "GPL" from list of licenses that need mentioning in ACEPTABLE_LICENSES

Crossref packages(7), add GPL as another option to ACCEPTABLE_LICENSES,
mention that PASSIVE_FETCH is the default in NetBSD-current, clarify
that many of the variables are only used inside the NetBSD packages
collection, document WINDOWMAKER_OPTIONS, move section no how to override
the MASTER_SITES_* to packages(7).

- Mention pkgsrc/mk/mk.conf.examples earlier
- USE_LOCALBASE_FOR_X11 is not ready for prime time, remove.

documentation for /etc/mk.conf