[src/trunk]: src/sys/rump document RUMP_SYM_NORENAME

[pooka <pooka%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/0f71b0f0be4d
branches:  trunk
changeset: 330066:0f71b0f0be4d
user:      pooka <pooka%NetBSD.org@localhost>
date:      Fri Jun 20 12:36:31 2014 +0000

description:
document RUMP_SYM_NORENAME

diffstat:

 sys/rump/README.compileopts |  23 ++++++++++++++++++++++-
 1 files changed, 22 insertions(+), 1 deletions(-)

diffs (44 lines):

diff -r 5a2ce702d4a1 -r 0f71b0f0be4d sys/rump/README.compileopts
--- a/sys/rump/README.compileopts       Fri Jun 20 12:31:55 2014 +0000
+++ b/sys/rump/README.compileopts       Fri Jun 20 12:36:31 2014 +0000
@@ -1,4 +1,4 @@
-       $NetBSD: README.compileopts,v 1.4 2014/04/23 23:25:45 pooka Exp $
+       $NetBSD: README.compileopts,v 1.5 2014/06/20 12:36:31 pooka Exp $
 
 This file describes compile-time options for rump kernels.  Additionally,
 NetBSD build options will have an effect.  See src/share/mk/bsd.README
@@ -6,6 +6,8 @@
 
 Note: after changing an option, do a clean build.
 
+Global options:
+
 
     RUMP_DIAGNOSTIC
 
@@ -77,6 +79,25 @@
 
 ================================================================================
 
+Per-component options:
+
+    RUMP_SYM_NORENAME
+
+values: regexp matching symbol names
+defval: <undefined>
+effect: Causes matching symbols from the component to not be renamed
+       into the rump kernel symbol namespace (rumpns_).  This option
+       can only be used in embedded environments where there is full
+       control over the platform's namespace.  Conversely, this option
+       cannot be used in kernel components which are not meant to be
+       tied to a specific platform.  Note: the value is processed by
+       make and must be appropriately escaped.  example:
+       RUMP_SYM_NORENAME=HYPERVISOR_|block$$
+       will not rename "^HYPERVISOR_" or "^block$"
+
+
+================================================================================
+
 
 The rest of the options described in this file are not intended to be
 set by users, but by the package building rump kernels.