Bug 161017

Summary:

[patch] add a helpful blurb about PORTS_MODULES to build(7)

Product:

Documentation

Reporter:

Enji Cooper <ngie>

Component:

Books & Articles

Assignee:

Glen Barber <gjb>

Status:

Closed FIXED

Severity:

Affects Only Me

Priority:

Normal

Version:

Latest

Hardware:

Any

OS:

Any

Attachments:

Description	Flags
file.diff	none

Description Enji Cooper freebsd_committer

2011-09-25 20:10:08 UTC

PORTS_MODULES is a very handy knob for folks that build kernels from source that allows one to specify a list of ports to build and install when running buildkernel and installkernel. It should be documented for power users to help improve the source upgrade process.

The attached patch adds a blurb to build(7) about PORTS_MODULES.

Fix: Patch attached with submission follows:

Comment 1 dfilter service freebsd_committer

2011-09-29 03:52:48 UTC

Author: gjb (doc committer)
Date: Thu Sep 29 02:52:33 2011
New Revision: 225858
URL: http://svn.freebsd.org/changeset/base/225858

Log:
  Document, and provide an example for, PORTS_MODULES in build(7).
  
  PR:		161017
  Submitted by:	gcooper
  MFC after:	1 week

Modified:
  head/share/man/man7/build.7

Modified: head/share/man/man7/build.7
==============================================================================
--- head/share/man/man7/build.7	Thu Sep 29 02:29:32 2011	(r225857)
+++ head/share/man/man7/build.7	Thu Sep 29 02:52:33 2011	(r225858)
@@ -414,6 +414,16 @@ is set to the value of 
 .It Va LOCAL_DIRS
 If set, this variable supplies a list of additional directories to
 build, relative to the root of the source tree.
+.It Va PORTS_MODULES
+A list of ports with kernel modules that should be built and installed
+as part of the
+.Cm buildkernel
+and
+.Cm installkernel
+process.
+.Bd -literal -offset indent
+make PORTS_MODULES=emulators/kqemu-kmod kernel
+.Ed
 .It Va SUBDIR_OVERRIDE
 Override the default list of sub-directories and only build the
 sub-directory named in this variable.
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"

Comment 2 Glen Barber freebsd_committer

2011-09-29 03:52:50 UTC

State Changed
From-To: open->patched

Patched in HEAD with minor changes.  MFC in 1 week.

Comment 3 Glen Barber freebsd_committer

2011-09-29 03:52:50 UTC

Responsible Changed
From-To: freebsd-bugs->gjb

Over to me.

Comment 4 dfilter service freebsd_committer

2011-10-10 12:14:17 UTC

Author: gjb (doc committer)
Date: Mon Oct 10 11:14:03 2011
New Revision: 226193
URL: http://svn.freebsd.org/changeset/base/226193

Log:
  MFC r225858, 225859, 226172:
  
  225858:
   - Document and provide an example for PORTS_MODULES [1]
  
  225859:
   - Whitespace cleanup
  
  226172:
   - Bump date
  
  PR:		161017 [1]
  Approved by:	re (kib)

Modified:
  stable/9/share/man/man7/build.7
Directory Properties:
  stable/9/share/man/man7/   (props changed)

Modified: stable/9/share/man/man7/build.7
==============================================================================
--- stable/9/share/man/man7/build.7	Mon Oct 10 11:12:40 2011	(r226192)
+++ stable/9/share/man/man7/build.7	Mon Oct 10 11:14:03 2011	(r226193)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd June 16, 2011
+.Dd September 29, 2011
 .Dt BUILD 7
 .Os
 .Sh NAME
@@ -238,7 +238,7 @@ This command takes a long time.
 Get updated sources as configured in
 .Xr make.conf 5 .
 .It Cm targets
-Print a list of supported 
+Print a list of supported
 .Va TARGET
 /
 .Va TARGET_ARCH
@@ -399,21 +399,31 @@ It defaults to
 .It Va KERNFAST
 If set, the build target
 .Cm buildkernel
-defaults to setting 
+defaults to setting
 .Va NO_KERNELCLEAN ,
 .Va NO_KERNELCONFIG ,
-.Va NO_KERNELDEPEND 
+.Va NO_KERNELDEPEND
 and
 .Va NO_KERNELOBJ .
 When set to a value other than
 .Cm 1
-then 
-.Va KERNCONF 
-is set to the value of 
+then
+.Va KERNCONF
+is set to the value of
 .Va KERNFAST .
 .It Va LOCAL_DIRS
 If set, this variable supplies a list of additional directories to
 build, relative to the root of the source tree.
+.It Va PORTS_MODULES
+A list of ports with kernel modules that should be built and installed
+as part of the
+.Cm buildkernel
+and
+.Cm installkernel
+process.
+.Bd -literal -offset indent
+make PORTS_MODULES=emulators/kqemu-kmod kernel
+.Ed
 .It Va SUBDIR_OVERRIDE
 Override the default list of sub-directories and only build the
 sub-directory named in this variable.
@@ -442,11 +452,11 @@ output.
 Set this to cross-build for a different architecture.
 If not set,
 .Va TARGET_ARCH
-defaults to the current machine architecture, unless 
+defaults to the current machine architecture, unless
 .Va TARGET
 is also set, in which case it defaults to the appropriate
 value for that platform.
-Typically, one only needs to set 
+Typically, one only needs to set
 .Va TARGET .
 .El
 .Pp
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"

Comment 5 dfilter service freebsd_committer

2011-10-10 12:15:13 UTC

Author: gjb (doc committer)
Date: Mon Oct 10 11:14:44 2011
New Revision: 226194
URL: http://svn.freebsd.org/changeset/base/226194

Log:
  MFC r225858, 225859, 226172:
  
  225858:
   - Document and provide an example for PORTS_MODULES [1]
  
  225859:
   - Whitespace cleanup
  
  226172:
   - Bump date
  
  PR:		161017 [1]

Modified:
  stable/8/share/man/man7/build.7
Directory Properties:
  stable/8/share/man/man7/   (props changed)
  stable/8/share/man/man7/ports.7   (props changed)

Modified: stable/8/share/man/man7/build.7
==============================================================================
--- stable/8/share/man/man7/build.7	Mon Oct 10 11:14:03 2011	(r226193)
+++ stable/8/share/man/man7/build.7	Mon Oct 10 11:14:44 2011	(r226194)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd February 10, 2011
+.Dd September 29, 2011
 .Dt BUILD 7
 .Os
 .Sh NAME
@@ -365,21 +365,31 @@ It defaults to
 .It Va KERNFAST
 If set, the build target
 .Cm buildkernel
-defaults to setting 
+defaults to setting
 .Va NO_KERNELCLEAN ,
 .Va NO_KERNELCONFIG ,
-.Va NO_KERNELDEPEND 
+.Va NO_KERNELDEPEND
 and
 .Va NO_KERNELOBJ .
 When set to a value other than
 .Cm 1
-then 
-.Va KERNCONF 
-is set to the value of 
+then
+.Va KERNCONF
+is set to the value of
 .Va KERNFAST .
 .It Va LOCAL_DIRS
 If set, this variable supplies a list of additional directories to
 build, relative to the root of the source tree.
+.It Va PORTS_MODULES
+A list of ports with kernel modules that should be built and installed
+as part of the
+.Cm buildkernel
+and
+.Cm installkernel
+process.
+.Bd -literal -offset indent
+make PORTS_MODULES=emulators/kqemu-kmod kernel
+.Ed
 .It Va SUBDIR_OVERRIDE
 Override the default list of sub-directories and only build the
 sub-directory named in this variable.
@@ -408,11 +418,11 @@ output.
 Set this to cross-build for a different architecture.
 If not set,
 .Va TARGET_ARCH
-defaults to the current machine architecture, unless 
+defaults to the current machine architecture, unless
 .Va TARGET
 is also set, in which case it defaults to the appropriate
 value for that platform.
-Typically, one only needs to set 
+Typically, one only needs to set
 .Va TARGET .
 .El
 .Pp
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"

Comment 6 dfilter service freebsd_committer

2011-10-10 12:16:05 UTC

Author: gjb (doc committer)
Date: Mon Oct 10 11:15:57 2011
New Revision: 226195
URL: http://svn.freebsd.org/changeset/base/226195

Log:
  MFC r225858, 225859, 226172:
  
  225858:
   - Document and provide an example for PORTS_MODULES [1]
  
  225859:
   - Whitespace cleanup
  
  226172:
   - Bump date
  
  PR:		161017 [1]

Modified:
  stable/7/share/man/man7/build.7
Directory Properties:
  stable/7/share/man/man7/   (props changed)
  stable/7/share/man/man7/ports.7   (props changed)

Modified: stable/7/share/man/man7/build.7
==============================================================================
--- stable/7/share/man/man7/build.7	Mon Oct 10 11:14:44 2011	(r226194)
+++ stable/7/share/man/man7/build.7	Mon Oct 10 11:15:57 2011	(r226195)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd March 31, 2010
+.Dd September 29, 2011
 .Dt BUILD 7
 .Os
 .Sh NAME
@@ -352,6 +352,16 @@ variables:
 .It Va LOCAL_DIRS
 If set, this variable supplies a list of additional directories to
 build, relative to the root of the source tree.
+.It Va PORTS_MODULES
+A list of ports with kernel modules that should be built and installed
+as part of the
+.Cm buildkernel
+and
+.Cm installkernel
+process.
+.Bd -literal -offset indent
+make PORTS_MODULES=emulators/kqemu-kmod kernel
+.Ed
 .It Va SUBDIR_OVERRIDE
 Override the default list of sub-directories and only build the
 sub-directory named in this variable.
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"

Comment 7 Glen Barber freebsd_committer

2011-10-10 12:18:09 UTC

State Changed
From-To: patched->closed

MFC'd to 9-STABLE, 8-STABLE, 7-STABLE.  Thanks!