Commit Graph

42 Commits

Author SHA1 Message Date
Gordon Bergling
e6ca69017c 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
2020-09-11 18:09:49 +00:00
Eitan Adler
b1a0e564ed src.conf: use more natural language for @generated
Requested by:	emaste
2018-05-26 21:14:49 +00:00
Eitan Adler
0db9a543bc 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.
2018-05-23 03:41:22 +00:00
Bryan Drewery
dfa099890c 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
2017-11-01 21:22:05 +00:00
Bryan Drewery
177d707c0c makeman: Ensure MK_AUTO_OBJ is disabled in some lookups.
Sponsored by:	Dell EMC Isilon
2017-10-31 02:18:06 +00:00
Baptiste Daroussin
57989d92a4 Remove some workaround for an option that does not exists anymore. 2017-06-07 23:42:37 +00:00
Ed Maste
0af1da97ee makeman: reword description, based on feedback from wblock 2017-05-15 18:02:13 +00:00
Ed Maste
9dc5d76e10 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
2017-04-19 18:11:08 +00:00
Ed Maste
983e409609 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
2017-04-11 17:01:20 +00:00
Enji Cooper
cbc5a508d8 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
2017-03-23 02:26:15 +00:00
Enji Cooper
fd4f2cd514 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
2017-03-23 02:16:56 +00:00
Warren Block
4af17bf5c0 Re-enable an accidentally-disabled temp directory creation test.
Reported by:	bjk
Sponsored by:	iXsystems
2017-02-03 20:17:54 +00:00
Warren Block
7a206c317d 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
2017-02-03 19:09:46 +00:00
Ed Maste
b7f38e69a9 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
2016-10-05 20:12:00 +00:00
Bryan Drewery
5d111a9744 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
2015-12-15 18:42:30 +00:00
Hajimu UMEMOTO
f1f871e17d Fix breakage by recent collation change.
LC_ALL has to be exported.
2015-11-28 00:41:37 +00:00
Simon J. Gerraty
32b5dc9a48 Regen src.conf.5 2015-11-14 04:50:28 +00:00
Bryan Drewery
3dfad7c764 Don't allow environment-set options to bleed into src.conf.5 generation.
MFC after:	2 weeks
Sponsored by:	EMC / Isilon Storage Division
2015-11-06 05:28:08 +00:00
Bryan Drewery
317c99b793 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
2015-09-17 22:04:46 +00:00
Bryan Drewery
4078537c17 Optimize makeman slightly by removing uneeded cat and extra test -s.
Sponsored by:	EMC / Isilon Storage Division
2015-09-17 20:45:51 +00:00
Bryan Drewery
da6e996de3 src.conf.5: Make it self-documenting that the mkopts are environment-only.
Sponsored by:	EMC / Isilon Storage Division
2015-09-17 20:33:52 +00:00
Bryan Drewery
ca04571419 Document src-env.conf and note its use for MAKEOBJDIRPREFIX and WITH_META_MDOE.
Sponsored by:	EMC / Isilon Storage Division
2015-09-17 17:45:20 +00:00
Simon J. Gerraty
cc2520d2f3 Fix generation of src.conf.5
Since makeman turns all options on, we need to guard somethings from
make(showconfig)
2015-06-22 20:21:57 +00:00
Ed Maste
c5d9ea913f Report failing value from 'make showconfig' in build option script
Sponsored by:	The FreeBSD Foundation
2015-06-22 17:23:36 +00:00
Dag-Erling Smørgrav
69c469c9d7 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)
2013-10-01 07:22:04 +00:00
Baptiste Daroussin
e9f950b59c Ensure the locale is LC_ALL=C when regenerating src.conf.5
MFC after:	3 days
2013-07-12 23:08:44 +00:00
Ed Maste
e60c420fa3 Use portable string comparison
We support == in /bin/sh now, but it ought to be avoided, and my use of
it was accidental.
2013-06-13 13:05:08 +00:00
Ed Maste
f506e293ab 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.
2013-06-10 13:55:03 +00:00
Glen Barber
691b39b51e Add '-width Pa' to src.conf.5 for mdoc(7) style consistency.
MFC after:	3 days
2012-05-30 02:37:20 +00:00
Ruslan Ermilov
e6a714e703 Reassurance for impatient. 2011-05-10 13:01:11 +00:00
Ruslan Ermilov
cae68bef11 Style. 2011-05-10 12:57:39 +00:00
Ruslan Ermilov
2701a1b7a1 - 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.
2011-05-10 11:14:40 +00:00
Dag-Erling Smørgrav
158e440d2b executable 2011-04-28 11:21:49 +00:00
Mike Makonnen
3d919b7521 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>
2009-02-20 11:09:55 +00:00
Ruslan Ermilov
6dc51eca81 - 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.
2007-12-12 16:39:32 +00:00
Daniel Gerzo
f61b0b51ed s/maybe/may be/
MFC after: 3 days
2007-11-06 23:12:53 +00:00
Ruslan Ermilov
c1e29f712e - Utilize the "showconfig" top-level target.
- Pass __MAKE_CONF=/dev/null to get a pristine output.
2006-09-11 13:39:44 +00:00
Yaroslav Tykhiy
c3b08cc667 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.
2006-07-31 12:41:13 +00:00
Tom Rhodes
07b7d7fbdf Switch value back to values.
Requested by:	ru
2006-05-20 04:32:10 +00:00
Tom Rhodes
57caf3d61f Some minor wording/description changes.
Reviewed by:	ru (two months ago)
2006-05-16 18:59:00 +00:00
Ruslan Ermilov
41c8ddc37f Fix generation of '$FreeBSD$'. 2006-03-21 09:08:45 +00:00
Ruslan Ermilov
c5922fbf80 A tool to generate the src.conf(5) manpage. 2006-03-21 09:05:42 +00:00