git: e7a13643b17c - main - build.7: Document LOCAL_MODULES and LOCAL_MODULES_DIR

[John Baldwin]

On 8/10/21 8:43 AM, Mark Johnston wrote:
> The branch main has been updated by markj:
> 
> URL: https://cgit.FreeBSD.org/src/commit/?id=e7a13643b17c3ec7357b26324986587dab810da5
> 
> commit e7a13643b17c3ec7357b26324986587dab810da5
> Author:     Mark Johnston <markj at FreeBSD.org>
> AuthorDate: 2021-08-10 15:42:35 +0000
> Commit:     Mark Johnston <markj at FreeBSD.org>
> CommitDate: 2021-08-10 15:43:02 +0000
> 
>      build.7: Document LOCAL_MODULES and LOCAL_MODULES_DIR
>      
>      Reviewed by:    0mp, imp
>      MFC after:      1 week
>      Sponsored by:   The FreeBSD Foundation
>      Differential Revision:  https://reviews.freebsd.org/D31461
> ---
>   share/man/man7/build.7 | 15 ++++++++++++++-
>   1 file changed, 14 insertions(+), 1 deletion(-)
> 
> diff --git a/share/man/man7/build.7 b/share/man/man7/build.7
> index 9d311a2f2f6c..c589fb7e0b9a 100644
> --- a/share/man/man7/build.7
> +++ b/share/man/man7/build.7
> @@ -24,7 +24,7 @@
>   .\"
>   .\" $FreeBSD$
>   .\"
> -.Dd July 1, 2021
> +.Dd August 10, 2021
>   .Dt BUILD 7
>   .Os
>   .Sh NAME
> @@ -601,6 +601,19 @@ process.
>   .Bd -literal -offset indent
>   make PORTS_MODULES=emulators/virtualbox-ose-kmod kernel
>   .Ed
> +.It Va LOCAL_MODULES
> +A list of external kernel modules that should be built and installed
> +as part of the
> +.Cm buildkernel
> +and
> +.Cm installkernel
> +process.
> +.It Va LOCAL_MODULES_DIR
> +The directory in which to search for the kernel modules specified by
> +.Va LOCAL_MODULES .
> +Each kernel module should consist of a directory containing a makefile.
> +Defaults to
> +.Pa ${LOCALBASE}/sys/modules .

Thanks for doing this.  The only thing we might want to add is to note that
LOCAL_MODULES is automatically set to all the subdirs in LOCAL_MODULES_DIR
if it is not explicitly set.

-- 
John Baldwin