Fwd: Patch file for man pages netmap.4, src.conf.5, build.7
Russell Haley
russ.haley at gmail.com
Sat Oct 17 06:13:28 UTC 2015
Ha ha, now WITH attachment...
Russell
---------- Forwarded message ----------
From: Russell Haley <russ.haley at gmail.com>
Date: Fri, Oct 16, 2015 at 11:11 PM
Subject: Patch file for man pages netmap.4, src.conf.5, build.7
To: freebsd-arm <freebsd-arm at freebsd.org>, freebsd-doc at freebsd.org
Cc: Warner Losh <imp at bsdimp.com>, Ian Lepore <ian at freebsd.org>, John-Mark
Gurney <jmg at funkthat.com>
Hi,
There was a previous discussion about making some small changes to the
src.conf and build man pages to include reference to src.conf.5 in the
buikd.7 manpage. I have updated the two documents appropriately. I believe
I also addressed Mr. Loshs' comment pertaining to the scope of the src.conf
file and the format of the title. I also found a typo in netmap.4.
In terms of coming up to speed with documentation, I had asked about where
to find documentation about, er, documentation and started with the
Documentation Primer (Why is this a "primer" and others are a "handbook"?).
This seems to me to be a mistake. After claiming domain over man pages, the
"primer" never mentions mdoc, groff, troff, man, mandoc or any other item
that seems remotely related to man pages ever again? Please, correct me if
I am wrong.
I did however find the following bits of information:
https://forums.freebsd.org/threads/howto-create-a-manpage-from-scratch.13200/
https://www.freebsd.org/cgi/man.cgi?query=mdoc&apropos=0&sektion=0&manpath=FreeBSD+10.2-RELEASE&arch=default&format=html
http://mdocml.bsd.lv/
http://mdocml.bsd.lv/man/mdoc.7.html
http://manpages.bsd.lv/
Which could be pieced nicely together to make a man pages handbook or at
least a section in the "primer"?
Thanks,
Russell
-------------- next part --------------
Index: man4/netmap.4
===================================================================
--- man4/netmap.4 (revision 289411)
+++ man4/netmap.4 (working copy)
@@ -385,7 +385,7 @@
TX [..........aaaaaaaaaaa........]
.Ed
.Pp
-select() and poll() wlll block if there is no space in the ring, i.e.
+select() and poll() will block if there is no space in the ring, i.e.
.Dl ring->cur == ring->tail
and return when new slots have become available.
.Pp
Index: man5/src.conf.5
===================================================================
--- man5/src.conf.5 (revision 289411)
+++ man5/src.conf.5 (working copy)
@@ -2,7 +2,7 @@
.\" from FreeBSD: head/tools/build/options/makeman 287942 2015-09-17 22:04:46Z bdrewery
.\" $FreeBSD$
.Dd September 18, 2015
-.Dt SRC.CONF 5
+.Dt src.conf 5
.Os
.Sh NAME
.Nm src.conf
@@ -10,15 +10,15 @@
.Sh DESCRIPTION
The
.Nm
-file contains settings that will apply to every build involving the
+file contains variables that control what components will be generated during the build process
+of the
.Fx
-source tree; see
+source tree (/usr/src); see
.Xr build 7 .
.Pp
The
.Nm
-file uses the standard makefile syntax.
-However,
+file uses the standard makefile syntax. However,
.Nm
should not specify any dependencies to
.Xr make 1 .
@@ -39,8 +39,7 @@
Overriding the location of
.Nm
may be necessary if the system-wide settings are not suitable
-for a particular build.
-For instance, setting
+for a particular build. For instance, setting
.Va SRCCONF
to
.Pa /dev/null
@@ -82,8 +81,7 @@
.Dq Li FALSE
or
.Dq Li NO .
-Just the existence of an option will cause
-it to be honoured by
+Just the existence of an option will cause it to be honoured by
.Xr make 1 .
.Pp
The following list provides a name and short description for variables
Index: man7/build.7
===================================================================
--- man7/build.7 (revision 289411)
+++ man7/build.7 (working copy)
@@ -25,11 +25,11 @@
.\" $FreeBSD$
.\"
.Dd December 31, 2014
-.Dt BUILD 7
+.Dt Build 7
.Os
.Sh NAME
.Nm build
-.Nd information on how to build the system
+.Nd General instructions on how to build the system
.Sh DESCRIPTION
The sources for the
.Fx
@@ -66,32 +66,30 @@
things in that directory.
Issuing the
.Xr make 1
-command in any directory or
-subdirectory of those directories has the same effect as issuing the
-same command in all subdirectories of that directory.
-With no target specified, the things in that directory are just built.
+command in any directory issues the
+.Xr make 1
+command recursively in all subdirectories.
+With no target specified, the items in the directories are built
+and no further action is taken.
.Pp
-A source tree is allowed to be read-only.
-As described in
-.Xr make 1 ,
-objects are usually built in a separate object directory hierarchy
-specified by the environment variable
-.Va MAKEOBJDIRPREFIX ,
-or under
+A source tree is allowed to be read-only as all build artifcats generated by
+.Xr make 1
+are generated in
.Pa /usr/obj
-if variable
+by default. The destination directory can be changed by specifying
+a new location using
.Va MAKEOBJDIRPREFIX
-is not set.
-For a given source directory, its canonical object directory
-would be
-.Pa ${MAKEOBJDIRPREFIX}${.CURDIR}
-if
-.Xr make 1
-variable
+as described in
+.Xr make 1 .
+
+Therefore, for a given source directory, its build artifacts
+would be generated in
+.Pa /usr/obj/${.CURDIR}
+or to
+.Pa ${MAKEOBJDIRPREFIX}/${.CURDIR}
+according to the
.Va MAKEOBJDIRPREFIX
-is set, or
-.Pa /usr/obj${.CURDIR}
-if this variable is not set.
+variable.
Cross-builds set the object directory as described in the
documentation for the
.Cm buildworld
@@ -102,8 +100,14 @@
variables described in the
.Sx ENVIRONMENT
section below, and by the variables documented in
-.Xr make.conf 5 .
+.Xr make.conf 5 .
.Pp
+The default components included in the build are specified in the file
+/etc/src.conf in the source tree. To override the default file, include
+the SRCCONF option in the make steps, pointing to a custom src.conf
+file. For more information see
+.Xr src.conf 5 .
+.Pp
The following list provides the names and actions for the targets
supported by the build system:
.Bl -tag -width ".Cm cleandepend"
@@ -445,6 +449,9 @@
.Bd -literal -offset indent
make PORTS_MODULES=emulators/kqemu-kmod kernel
.Ed
+.It Va SRCCONF
+Specify a file to override the default /etc/src.conf. The src.conf file controls the components to build. See
+.Xr SRC.CONF 5
.It Va STRIPBIN
Command to use at install time when stripping binaries.
Be sure to add any additional tools required to run
More information about the freebsd-doc
mailing list