History log of /freebsd-current/tools/build/options/makeman
Revision Date Author Comments
# 65fd76b5 13-May-2024 Ed Maste <emaste@FreeBSD.org>

makeman: extend duplicate option warning to OPT_ options

In a local tree I accidentally had OPT_INIT_ALL defaulting to zero in
userland and none in kernel. This resulted in the INIT_ALL text
appearing twice in src.conf.5.

Reviewed by: brooks
Sponsored by: The FreeBSD Foundation
Differential Revision: https://reviews.freebsd.org/D45184


# 9c80d66e 08-Sep-2023 John Baldwin <jhb@FreeBSD.org>

makeman: Use ${make} instead of plain make to compute ${requireds}

This is currently a no-op but can matter for downstreams whose ${make}
includes additional settings.

Reviewed by: imp, emaste
Obtained from: CheriBSD
Sponsored by: DARPA
Differential Revision: https://reviews.freebsd.org/D41777


# 897ae85f 01-Sep-2023 Brooks Davis <brooks@FreeBSD.org>

makeman: add minimal support for group options

Ignore OPT_* values in showconfig out in exising code paths and add
a new path to include descriptions for each. For now, hardcode the
description contents rather than attempting to generate it. This runs
the risk of docs getting out of date, limits the amount of new shell
code added today while a lua rewrite is nearly ready to land.

This change requires a followup commit to enable OPT_* values in
"make showconfig" in order to actually find group options.

Reviewed by: emaste
Differential Revision: https://reviews.freebsd.org/D41681


# 89aed883 31-Aug-2023 Brooks Davis <brooks@FreeBSD.org>

makeman: clarify scope of ignored option values

The values of WITH_ and WITHOUT_ options are ignored, but group options
are not.

Reviewed by: imp, emaste
Differential Revision: https://reviews.freebsd.org/D41683


# d0b2dbfa 16-Aug-2023 Warner Losh <imp@FreeBSD.org>

Remove $FreeBSD$: one-line sh pattern

Remove /^\s*#[#!]?\s*\$FreeBSD\$.*$\n/


# bce99679 17-Jun-2023 Colin Percival <cperciva@FreeBSD.org>

options/makeman: Handle __REQUIRED_OPTIONS

Teach the code which generates src.conf.5 about __REQUIRED_OPTIONS;
without this change it gets confused and thinks that every option
turns the required options on.

Reviewed by: sjg, imp
Differential Revision: https://reviews.freebsd.org/D40591


# baf2dc64 23-Apr-2023 Simon J. Gerraty <sjg@FreeBSD.org>

Set UPDATE_DEPDFILE=NO for showconfig

Exporting UPDATE_DEPDFILE=NO from makeman didn't work,
back to setting it in local.meta.sys.env.mk


# 16161b48 22-Apr-2023 Simon J. Gerraty <sjg@FreeBSD.org>

makeman export UPDATE_DEPENFILE=no

Just to be clear we do not need any updates.


# cc36164a 08-Mar-2023 Brooks Davis <brooks@FreeBSD.org>

makeman: replace -\|/ twiddles with dots

It shows progress more clearly, there aren't so many that the output
is excessive, and it's more friendly for things like Cirrus-CI's
logging that print the backspaces as boxes.

Reviewed by: emaste
Sponsored by: DARPA
Differential Revision: https://reviews.freebsd.org/D38990


# fca7df1b 08-Mar-2023 Brooks Davis <brooks@FreeBSD.org>

makeman: don't insert a $FreeBSD$

There's no need to insert this line which won't be expanded in git. Not
generating it won't impact MFCs to 12 since the removal won't be MFCd.

Reviewed by: emaste
Sponsored by: DARPA
Differential Revision: https://reviews.freebsd.org/D38989


# 42afe48b 08-Mar-2023 Brooks Davis <brooks@FreeBSD.org>

makeman: fix a whitespace bug

Reviewed by: emaste
Sponsored by: DARPA
Differential Revision: https://reviews.freebsd.org/D38988


# e6ca6901 11-Sep-2020 Gordon Bergling <gbe@FreeBSD.org>

Improvements for the src.conf(5) and build(7) man pages

PR: 203863 (based on)
Submitted by: Russell Haley <russ dot haley at gmail dot com>
Reviewed by: bcr, imp
Approved by: imp
MFC after: 1 week
Differential Revision: https://reviews.freebsd.org/D26343


# b1a0e564 26-May-2018 Eitan Adler <eadler@FreeBSD.org>

src.conf: use more natural language for @generated

Requested by: emaste


# 0db9a543 22-May-2018 Eitan Adler <eadler@FreeBSD.org>

Add the text '@generated' to src.conf.5

This is a cross-tool approach to identifying generated code. Some tools,
notably phabricator, handle this marker specially. See
https://reviews.freebsd.org/differential/diff/42870/ for such an
example.


# dfa09989 01-Nov-2017 Bryan Drewery <bdrewery@FreeBSD.org>

Add option UNIFIED_OBJDIR, on by default, which moves the default build OBJDIR.

This changes the build OBJDIR from the older style of /usr/obj/<srcdir> for
native builds, and /usr/obj/<target>.<target_arch>/<srcdir> for cross builds to
a new simpler format of /usr/obj/<srcdir>/<target>.<target_arch>. This
new format is used regardless of cross or native build. It allows
easier management of multiple source tree object directories.

The UNIFIED_OBJDIR option will be removed and its feature made permanent
for the 12.0 release.

Relnotes: yes (don't note UNIFIED_OBJDIR option since it will be removed)
Prior work: D3711 D874
Reviewed by: gjb, sjg
Discussed at: https://lists.freebsd.org/pipermail/freebsd-arch/2016-May/017805.html
Discussed with: emaste
Sponsored by: Dell EMC Isilon
Differential Revision: https://reviews.freebsd.org/D12840


# 177d707c 30-Oct-2017 Bryan Drewery <bdrewery@FreeBSD.org>

makeman: Ensure MK_AUTO_OBJ is disabled in some lookups.

Sponsored by: Dell EMC Isilon


# 57989d92 07-Jun-2017 Baptiste Daroussin <bapt@FreeBSD.org>

Remove some workaround for an option that does not exists anymore.


# 0af1da97 15-May-2017 Ed Maste <emaste@FreeBSD.org>

makeman: reword description, based on feedback from wblock


# 9dc5d76e 19-Apr-2017 Ed Maste <emaste@FreeBSD.org>

makeman: add a comment describing purpose and invocation

Reviewed by: jhb, ngie
MFC after: 2 weeks
Sponsored by: The FreeBSD Foundation
Differential Revision: https://reviews.freebsd.org/D10389


# 983e4096 11-Apr-2017 Ed Maste <emaste@FreeBSD.org>

makeman: don't copy $FreeBSD$ tags from source files into output

Copying the source VCS ID from WITH_/WITHOUT_* into the generated
src.conf.5 is not necessary, as it is generally possible to determine
the same information using the VCS to examine commit metadata. The
individual source files also match the name of the option recorded in
the generated file, so it is clear from where the content originated.

The copied IDs generate extraneous, non-content noise in the generated
src.conf.5 in some cases, including the first time the file is generated
on a stable branch. In addition, the source file $FreeBSD$ tags are not
expanded by git or other non-Subversion VCSs, which means that makeman
previously could not be used in a non-Subversion working tree.

I accept that there's some desire to keep these, but on balance believe
there is more benefit in removing them.

Reviewed by: imp, ngie
MFC after: 1 month
Sponsored by: The FreeBSD Foundation
Differential Revision: https://reviews.freebsd.org/D7997


# cbc5a508 22-Mar-2017 Enji Cooper <ngie@FreeBSD.org>

Remove the .Pa portion I added to the .An macro in AUTHORS section

That doesn't work (mandoc complains about the macro being empty).

That's what I get for being clever and not verifying before committing
things again *sigh*.

MFC after: 1 month
X-MFC with: r315766
Partyhat to: ngie
Sponsored by: Dell EMC Isilon


# fd4f2cd5 22-Mar-2017 Enji Cooper <ngie@FreeBSD.org>

Note that tools/build/options/makeman automatically generated src.conf(5)

This (as a bonus) fixes mdoc warnings with src.conf(5) :)..

MFC after: 1 month
Sponsored by: Dell EMC Isilon


# 4af17bf5 03-Feb-2017 Warren Block <wblock@FreeBSD.org>

Re-enable an accidentally-disabled temp directory creation test.

Reported by: bjk
Sponsored by: iXsystems


# 7a206c31 03-Feb-2017 Warren Block <wblock@FreeBSD.org>

Clarify some option descriptions, add a line of text to makeman to
add the slightest hint of a shade of a clue of what it does.

Sponsored by: iXsystems


# b7f38e69 05-Oct-2016 Ed Maste <emaste@FreeBSD.org>

makeman: avoid bogus output with duplicated options

On some targets 'make showconfig' currently reports both 'no' and 'yes'
for some options. For example:

% make TARGET=mips showconfig | grep SSP
MK_SSP = no
MK_SSP = yes

Emit a warning on encountering a duplicated variable, and skip the
second entry.

Sponsored by: The FreeBSD Foundation


# 5d111a97 15-Dec-2015 Bryan Drewery <bdrewery@FreeBSD.org>

Correct comment about MAKEOBJDIRPREFIX in src-env.conf.

It may only be used with WITH_AUTO_OBJ, which the WITH_DIRDEPS_BUILD does. We
could support this in the normal build as well if we forced creating the directory
and setting .OBJDIR.

Sponsored by: EMC / Isilon Storage Division


# f1f871e1 27-Nov-2015 Hajimu UMEMOTO <ume@FreeBSD.org>

Fix breakage by recent collation change.
LC_ALL has to be exported.


# 32b5dc9a 13-Nov-2015 Simon J. Gerraty <sjg@FreeBSD.org>

Regen src.conf.5


# 3dfad7c7 05-Nov-2015 Bryan Drewery <bdrewery@FreeBSD.org>

Don't allow environment-set options to bleed into src.conf.5 generation.

MFC after: 2 weeks
Sponsored by: EMC / Isilon Storage Division


# 317c99b7 17-Sep-2015 Bryan Drewery <bdrewery@FreeBSD.org>

makeman: Fix handling of env-only vars by using SRC_ENV_CONF rather than SRCCONF.

Also note that these env-only vars can be specified on the command line.

This fixes the dependent options that are env-only (such as WITH_META_MODE
and WITH_AUTO_OBJ) to properly display their dependencies.

Sponsored by: EMC / Isilon Storage Division


# 4078537c 17-Sep-2015 Bryan Drewery <bdrewery@FreeBSD.org>

Optimize makeman slightly by removing uneeded cat and extra test -s.

Sponsored by: EMC / Isilon Storage Division


# da6e996d 17-Sep-2015 Bryan Drewery <bdrewery@FreeBSD.org>

src.conf.5: Make it self-documenting that the mkopts are environment-only.

Sponsored by: EMC / Isilon Storage Division


# ca045714 17-Sep-2015 Bryan Drewery <bdrewery@FreeBSD.org>

Document src-env.conf and note its use for MAKEOBJDIRPREFIX and WITH_META_MDOE.

Sponsored by: EMC / Isilon Storage Division


# cc2520d2 22-Jun-2015 Simon J. Gerraty <sjg@FreeBSD.org>

Fix generation of src.conf.5

Since makeman turns all options on, we need to guard somethings from
make(showconfig)


# c5d9ea91 22-Jun-2015 Ed Maste <emaste@FreeBSD.org>

Report failing value from 'make showconfig' in build option script

Sponsored by: The FreeBSD Foundation


# 69c469c9 01-Oct-2013 Dag-Erling Smørgrav <des@FreeBSD.org>

Have makeman always use the mk files from the source tree it's operating
on rather than those from the installed system.

Approved by: re (delphij)


# e9f950b5 12-Jul-2013 Baptiste Daroussin <bapt@FreeBSD.org>

Ensure the locale is LC_ALL=C when regenerating src.conf.5

MFC after: 3 days


# e60c420f 13-Jun-2013 Ed Maste <emaste@FreeBSD.org>

Use portable string comparison

We support == in /bin/sh now, but it ought to be avoided, and my use of
it was accidental.


# f506e293 10-Jun-2013 Ed Maste <emaste@FreeBSD.org>

Handle options that override other options

This is a workaround for WITH_LDNS_UTILS forcing BIND_UTILS off. It can
be reverted when we no longer have these conflicting options, or made more
general if we grow more cases like this.


# 691b39b5 29-May-2012 Glen Barber <gjb@FreeBSD.org>

Add '-width Pa' to src.conf.5 for mdoc(7) style consistency.

MFC after: 3 days


# e6a714e7 10-May-2011 Ruslan Ermilov <ru@FreeBSD.org>

Reassurance for impatient.


# cae68bef 09-May-2011 Ruslan Ermilov <ru@FreeBSD.org>

Style.


# 2701a1b7 10-May-2011 Ruslan Ermilov <ru@FreeBSD.org>

- There now exist options that have different defaults depending on
the architecture, reflect this in documentation. For such
options, both WITH_FOO and WITHOUT_FOO description files should
be provided.

Prodded by: des

- Setting a build option may enforce other build options, try harder
to detect this case.

- Setting a build option may change other option's default value,
try harder to detect this case.


# 158e440d 28-Apr-2011 Dag-Erling Smørgrav <des@FreeBSD.org>

executable


# a7d5f7eb 19-Oct-2010 Jamie Gritton <jamie@FreeBSD.org>

A new jail(8) with a configuration file, to replace the work currently done
by /etc/rc.d/jail.


# fe0506d7 09-Mar-2010 Marcel Moolenaar <marcel@FreeBSD.org>

Create the altix project branch. The altix project will add support
for the SGI Altix 350 to FreeBSD/ia64. The hardware used for porting
is a two-module system, consisting of a base compute module and a
CPU expansion module. SGI's NUMAFlex architecture can be an excellent
platform to test CPU affinity and NUMA-aware features in FreeBSD.


# 3d919b75 20-Feb-2009 Mike Makonnen <mtm@FreeBSD.org>

Doh! r188813 modified an auto-generated file. Fix it for real:
o grammar fix
o remove mention of libkse

Submitted by: Niclas Zeising <niclas.zeising@gmail.com>


# d7f03759 19-Oct-2008 Ulf Lilleengen <lulf@FreeBSD.org>

- Import the HEAD csup code which is the basis for the cvsmode work.


# 6dc51eca 12-Dec-2007 Ruslan Ermilov <ru@FreeBSD.org>

- Fix setting of MK_GSSAPI option by bsd.own.mk; its value should
default to the value of MK_KERBEROS unless set explicitly by
WITH_GSSAPI/WITHOUT_GSSAPI. (This introduces another type of
MK_* variables which itself is questionable.)

- Teach tools/build/options/makeman script that generates the
src.conf(5) manpage about the new type of MK_* variables.

- Fix broken logic in lib/Makefile.


# f61b0b51 06-Nov-2007 Daniel Gerzo <danger@FreeBSD.org>

s/maybe/may be/

MFC after: 3 days


# c1e29f71 11-Sep-2006 Ruslan Ermilov <ru@FreeBSD.org>

- Utilize the "showconfig" top-level target.
- Pass __MAKE_CONF=/dev/null to get a pristine output.


# c3b08cc6 30-Jul-2006 Yaroslav Tykhiy <ytykhiy@gmail.com>

Actually skip over undocumented options with "continue"
to avoid artifacts in the manpage generated. Previously
an orphaned paragraph on dependencies of such an option
would appear.


# 07b7d7fb 19-May-2006 Tom Rhodes <trhodes@FreeBSD.org>

Switch value back to values.

Requested by: ru


# 57caf3d6 16-May-2006 Tom Rhodes <trhodes@FreeBSD.org>

Some minor wording/description changes.

Reviewed by: ru (two months ago)


# 41c8ddc3 21-Mar-2006 Ruslan Ermilov <ru@FreeBSD.org>

Fix generation of '$FreeBSD$'.


# c5922fbf 21-Mar-2006 Ruslan Ermilov <ru@FreeBSD.org>

A tool to generate the src.conf(5) manpage.