tech-kern archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
Re: (patch) Improved documentation and examples of dynamic modules
Paul Goyette wrote:
> On Mon, 11 May 2015, Kamil Rytarowski wrote:
>
> > I've attached new patch.
>
> Thanks - I will review as soon as I can get to it.
>
Thank you!
> > For now I will schedule share/man pages for later.
> > After committing it please remove sys/modules/example.
> >
> > I went for share/examples/sys/kmodule.
>
> Well, I've done some more thinking on that topic! Greg Troxel has a
> good comment about continuing to build all the example modules as part
> of normal 'build.sh release'. In order to do that, and to get all the
> build goop right (Makefiles, Makefiles.inc, etc.) it will actually be
> easier to place them in the sys/modules/ hierarchy. So, one might say
> that I've "had second thoughts."
>
> I would now propose that we remove the existing sys/modules/example/
> code and place the several new example modules as subdirectories of the
> sys/modules/example/ directory. Then the main sys/modules/Makefile can
> descend into modules/examples, and a new Makefile there can further
> descend into the multiple subdirectories.
>
> I'll wait a few days (at least) before committing anything, to give the
> rest of the community an opportunity to respond.
>
>
I'm OK with this.
Could you please integrate my patch this way with src/sys?
I'm attaching a small patch for the man-pages. It's:
- adding new linked pages for MODULE(9) -> module(9), modcmd(9) -> module(9)
and uio(9) -> uiomove(9),
- including lua(9lua) reference in module(9).
I have a request to back-port it to NetBSD-7 as I want to depend on their
existence. Thanks!
Index: distrib/sets/lists/comp/mi
===================================================================
RCS file: /home/kamil/netbsd-cvs/netbsd/src/distrib/sets/lists/comp/mi,v
retrieving revision 1.1957
diff -u -r1.1957 mi
--- distrib/sets/lists/comp/mi 6 May 2015 15:57:07 -0000 1.1957
+++ distrib/sets/lists/comp/mi 11 May 2015 12:24:20 -0000
@@ -9741,6 +9741,7 @@
./usr/share/man/cat9/MGET.0 comp-sys-catman .cat
./usr/share/man/cat9/MGETHDR.0 comp-sys-catman .cat
./usr/share/man/cat9/MH_ALIGN.0 comp-sys-catman .cat
+./usr/share/man/cat9/MODULE.0 comp-sys-catman .cat
./usr/share/man/cat9/M_ALIGN.0 comp-sys-catman .cat
./usr/share/man/cat9/M_COPY_PKTHDR.0 comp-sys-catman .cat
./usr/share/man/cat9/M_LEADINGSPACE.0 comp-sys-catman .cat
@@ -10529,6 +10530,7 @@
./usr/share/man/cat9/microseq.0 comp-sys-catman .cat
./usr/share/man/cat9/microtime.0 comp-sys-catman .cat
./usr/share/man/cat9/microuptime.0 comp-sys-catman .cat
+./usr/share/man/cat9/modcmd.0 comp-sys-catman .cat
./usr/share/man/cat9/module.0 comp-sys-catman .cat
./usr/share/man/cat9/module_autoload.0 comp-sys-catman .cat
./usr/share/man/cat9/module_builtin_require_force.0 comp-sys-catman .cat
@@ -11001,6 +11003,7 @@
./usr/share/man/cat9/ubc_uiomove.0 comp-sys-catman .cat
./usr/share/man/cat9/ucas.0 comp-sys-catman .cat
./usr/share/man/cat9/ucom.0 comp-sys-catman .cat
+./usr/share/man/cat9/uio.0 comp-sys-catman .cat
./usr/share/man/cat9/uiomove.0 comp-sys-catman .cat
./usr/share/man/cat9/ungetnewvnode.0 comp-sys-catman .cat
./usr/share/man/cat9/untimeout.0 comp-sys-catman .cat
@@ -16554,6 +16557,7 @@
./usr/share/man/html9/MGET.html comp-sys-htmlman html
./usr/share/man/html9/MGETHDR.html comp-sys-htmlman html
./usr/share/man/html9/MH_ALIGN.html comp-sys-htmlman html
+./usr/share/man/html9/MODULE.html comp-sys-htmlman html
./usr/share/man/html9/M_ALIGN.html comp-sys-htmlman html
./usr/share/man/html9/M_COPY_PKTHDR.html comp-sys-htmlman html
./usr/share/man/html9/M_LEADINGSPACE.html comp-sys-htmlman html
@@ -17307,6 +17311,7 @@
./usr/share/man/html9/microseq.html comp-sys-htmlman html
./usr/share/man/html9/microtime.html comp-sys-htmlman html
./usr/share/man/html9/microuptime.html comp-sys-htmlman html
+./usr/share/man/html9/modcmd.html comp-sys-htmlman html
./usr/share/man/html9/module.html comp-sys-htmlman html
./usr/share/man/html9/module_autoload.html comp-sys-htmlman html
./usr/share/man/html9/module_builtin_require_force.html comp-sys-htmlman html
@@ -17768,6 +17773,7 @@
./usr/share/man/html9/ubc_uiomove.html comp-sys-htmlman html
./usr/share/man/html9/ucas.html comp-sys-htmlman html
./usr/share/man/html9/ucom.html comp-sys-htmlman html
+./usr/share/man/html9/uio.html comp-sys-htmlman html
./usr/share/man/html9/uiomove.html comp-sys-htmlman html
./usr/share/man/html9/ungetnewvnode.html comp-sys-htmlman html
./usr/share/man/html9/untimeout.html comp-sys-htmlman html
@@ -23471,6 +23477,7 @@
./usr/share/man/man9/MGET.9 comp-sys-man .man
./usr/share/man/man9/MGETHDR.9 comp-sys-man .man
./usr/share/man/man9/MH_ALIGN.9 comp-sys-man .man
+./usr/share/man/man9/MODULE.9 comp-sys-man .man
./usr/share/man/man9/M_ALIGN.9 comp-sys-man .man
./usr/share/man/man9/M_COPY_PKTHDR.9 comp-sys-man .man
./usr/share/man/man9/M_LEADINGSPACE.9 comp-sys-man .man
@@ -24260,6 +24267,7 @@
./usr/share/man/man9/microseq.9 comp-sys-man .man
./usr/share/man/man9/microtime.9 comp-sys-man .man
./usr/share/man/man9/microuptime.9 comp-sys-man .man
+./usr/share/man/man9/modcmd.9 comp-sys-man .man
./usr/share/man/man9/module.9 comp-sys-man .man
./usr/share/man/man9/module_autoload.9 comp-sys-man .man
./usr/share/man/man9/module_builtin_require_force.9 comp-sys-man .man
@@ -24748,6 +24756,7 @@
./usr/share/man/man9/ubc_uiomove.9 comp-sys-man .man
./usr/share/man/man9/ucas.9 comp-sys-man .man
./usr/share/man/man9/ucom.9 comp-sys-man .man
+./usr/share/man/man9/uio.9 comp-sys-man .man
./usr/share/man/man9/uiomove.9 comp-sys-man .man
./usr/share/man/man9/ungetnewvnode.9 comp-sys-man .man
./usr/share/man/man9/untimeout.9 comp-sys-man .man
Index: share/man/man9/Makefile
===================================================================
RCS file: /home/kamil/netbsd-cvs/netbsd/src/share/man/man9/Makefile,v
retrieving revision 1.386
diff -u -r1.386 Makefile
--- share/man/man9/Makefile 27 Apr 2015 07:03:57 -0000 1.386
+++ share/man/man9/Makefile 11 May 2015 12:20:22 -0000
@@ -492,7 +492,9 @@
microuptime.9 getmicrouptime.9 \
microuptime.9 nanouptime.9 \
microuptime.9 getnanouptime.9
-MLINKS+=module.9 module_autoload.9 \
+MLINKS+=module.9 MODULE.9 \
+ module.9 modcmd.9 \
+ module.9 module_autoload.9 \
module.9 module_builtin_require_force.9 \
module.9 module_find_section.9 \
module.9 module_hold.9 \
@@ -826,6 +828,9 @@
todr.9 clock_ymdhms_to_secs.9 todr.9 clock_secs_to_ymdhms.9
MLINKS+=ubc.9 ubc_alloc.9 ubc.9 ubc_release.9 ubc.9 ubc_uiomove.9
+
+MLINKS+=uiomove.9 uio.9
+
MLINKS+=uvm.9 uvm_init.9 uvm.9 uvm_init_limits.9 uvm.9 uvm_setpagesize.9 \
uvm.9 uvm_swap_init.9 uvm.9 uvm_fault.9 \
uvm.9 uvm_vnp_setsize.9 \
Index: share/man/man9/module.9
===================================================================
RCS file: /home/kamil/netbsd-cvs/netbsd/src/share/man/man9/module.9,v
retrieving revision 1.30
diff -u -r1.30 module.9
--- share/man/man9/module.9 18 Mar 2014 18:20:40 -0000 1.30
+++ share/man/man9/module.9 11 May 2015 12:25:01 -0000
@@ -447,6 +447,7 @@
.Fn module_init_md
is for finding modules passed in by the boot loader.
.Sh SEE ALSO
+.Xr lua 9lua ,
.Xr modctl 2 ,
.Xr module 7
.Sh HISTORY
Home |
Main Index |
Thread Index |
Old Index