Annotation of htdocs/developers/notes.html, revision 1.78

1.73      jym         1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
1.1       abs         2: <html>
                      3: <head>
1.47      hubertf     4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <meta name="generator" content="Website XSL Stylesheet V2.6.0">
1.50      kano        6: <link rel="home" href="../." title="Welcome to The NetBSD Project: Of course it runs NetBSD.">
                      7: <link rel="up" href="../developers/." title="NetBSD Developer Documentation">
                      8: <link rel="previous" href="../developers/new-port.html" title="NetBSD Developer Documentation: Adding a new port">
                      9: <link rel="next" href="../developers/pgp.html" title="PGP Key Management Guide for NetBSD developers">
                     10: <link rel="first" href="../developers/announce.html" title="NetBSD Developer Documentation: News story guidelines">
                     11: <link rel="last" href="../developers/www.html" title="NetBSD Developer Documentation: Information about the www
                     12:       mailing list">
1.63      dsieger    13: <link rel="stylesheet" href="../global.css" type="text/css">
1.47      hubertf    14: 
1.1       abs        15: 
                     16: 
                     17: <title>Misc developer notes</title>
                     18: </head>
1.47      hubertf    19: <body class="website"><div class="webpage">
1.54      dsieger    20: <a name="developers-notes"></a><div id="top"><a href="#mainContent" class="doNotDisplay doNotPrint">Skip to main content.</a></div>
1.73      jym        21: <div id="centralHeader">
1.75      jym        22: <div id="logo">
1.77      jym        23: <a href="../"><img alt="[NetBSD Logo]" src="../images/NetBSD-smaller.png"></a><div id="name"><a href="../">
1.75      jym        24:          The NetBSD Project
1.77      jym        25:        </a></div>
                     26: <div id="slogan"><a href="../">
1.75      jym        27:          &#8220;Of course it runs NetBSD&#8221;
1.77      jym        28:        </a></div>
1.75      jym        29: </div>
                     30: <div id="headerTools">
1.73      jym        31: <div id="header-cse-search-form">Google custom search</div>
1.71      spz        32: <script src="http://www.google.com/jsapi" type="text/javascript"></script><script type="text/javascript"> 
                     33:                  google.load('search', '1', {language : 'en'});
                     34:                  google.setOnLoadCallback(function() {
                     35:                    var header_customSearchControl = new google.search.CustomSearchControl('006277936787196004968:mbdhrauy1wm');
                     36:                    header_customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
                     37:                    var header_options = new google.search.DrawOptions();
                     38:                    header_options.enableSearchboxOnly("http://google.com/cse?cx=006277936787196004968:mbdhrauy1wm");    
                     39:                    header_customSearchControl.draw('header-cse-search-form', header_options);
                     40:                  }, true);
1.73      jym        41:                </script>
                     42: </div>
1.54      dsieger    43: </div>
1.73      jym        44: <div id="navBar" role="navigation">
1.57      dsieger    45: <span class="doNotDisplay">
                     46:          Navigation:
1.73      jym        47:        </span><ul>
                     48: <li><a href="../">
                     49:          Home</a></li>
                     50: <li>
                     51: <a href="../">
1.76      wiz        52:          News &amp; Media</a><ul>
1.73      jym        53: <li><a href="../changes/">
                     54:            Recent changes</a></li>
1.74      jym        55: <li><a href="http://blog.NetBSD.org/">
1.73      jym        56:            NetBSD blog</a></li>
                     57: <li><a href="../gallery/events.html">
                     58:            Events</a></li>
                     59: <li><a href="../changes/rss.html">
                     60:            Feeds</a></li>
                     61: </ul>
                     62: </li>
                     63: <li>
                     64: <a href="../about/">
                     65:          About</a><ul>
                     66: <li><a href="../about/">
                     67:            NetBSD</a></li>
                     68: <li><a href="../foundation/">
                     69:            The NetBSD Foundation</a></li>
                     70: <li><a href="../gallery/">
                     71:            Advocacy</a></li>
                     72: </ul>
                     73: </li>
                     74: <li>
                     75: <a href="../docs/">
                     76:          Documentation</a><ul>
                     77: <li><a href="../docs/misc/index.html">
                     78:            FAQ &amp; HOWTOs</a></li>
                     79: <li><a href="../docs/guide/en/">
                     80:            The Guide</a></li>
1.74      jym        81: <li><a href="http://man.NetBSD.org/">
1.73      jym        82:            Manual pages</a></li>
1.74      jym        83: <li><a href="http://wiki.NetBSD.org/">
1.73      jym        84:            Wiki</a></li>
                     85: </ul>
                     86: </li>
                     87: <li>
                     88: <a href="../support/">
                     89:          Support</a><ul>
                     90: <li><a href="../support/send-pr.html">
                     91:            Problem report guide</a></li>
                     92: <li><a href="../cgi-bin/sendpr.cgi?gndb=netbsd">
                     93:            Report a bug</a></li>
                     94: <li><a href="../support/query-pr.html">
                     95:            Query bug database</a></li>
                     96: <li><a href="../support/security/">
                     97:            Security</a></li>
                     98: </ul>
                     99: </li>
                    100: <li>
                    101: <a href="../community/">
                    102:          Community</a><ul>
                    103: <li><a href="http://onetbsd.org/">
                    104:            Blogs</a></li>
                    105: <li><a href="../mailinglists/">
                    106:            Mailing lists</a></li>
1.74      jym       107: <li><a href="http://mail-index.NetBSD.org/">
1.73      jym       108:            List archives</a></li>
                    109: </ul>
                    110: </li>
                    111: <li>
                    112: <a href="../developers/">
                    113:          Developers</a><ul>
1.74      jym       114: <li><a href="http://cvsweb.NetBSD.org/">
1.73      jym       115:            Browse source</a></li>
1.74      jym       116: <li><a href="http://nxr.NetBSD.org/">
1.73      jym       117:            Cross-reference</a></li>
1.74      jym       118: <li><a href="http://releng.NetBSD.org/">
1.73      jym       119:            Release engineering</a></li>
1.74      jym       120: <li><a href="http://wiki.NetBSD.org/projects/">
1.73      jym       121:            Projects list</a></li>
                    122: </ul>
                    123: </li>
                    124: <li>
                    125: <a href="../ports/">
                    126:          Ports</a><ul>
                    127: <li><a href="../ports/history.html">
                    128:            History</a></li>
                    129: <li><a href="../ports/emulators.html">
                    130:            Emulators</a></li>
                    131: </ul>
                    132: </li>
                    133: <li>
                    134: <a href="http://www.pkgsrc.org/">
                    135:          Packages</a><ul>
                    136: <li><a href="http://www.pkgsrc.se/">
                    137:            Browse packages</a></li>
1.74      jym       138: <li><a href="http://releng.NetBSD.org/index-pkgsrc.html">
1.73      jym       139:            Release engineering</a></li>
                    140: </ul>
                    141: </li>
                    142: </ul>
1.54      dsieger   143: </div>
                    144: <div id="content"><div class="fullWidth"><div class="rowOfBoxes">
                    145: <h1>Misc developer notes</h1>
1.47      hubertf   146: <h3 class="title"><a name="misc-notes"></a></h3>
1.14      dent      147: <ul>
1.48      hubertf   148: <li><a href="#about">About this file</a></li>
1.47      hubertf   149: <li><a href="#elf-aout-align">ELF vs. a.out .align</a></li>
                    150: <li><a href="#bumping-version-numbers">Logs when bumping a kernel version number or an shlib_version file</a></li>
                    151: <li><a href="#sharing-userland">Sharing userland and MACHINE_ARCH</a></li>
                    152: <li><a href="#adding-library">Adding a new library</a></li>
                    153: <li><a href="#changing-library-versions">Changing the version number of a library</a></li>
                    154: <li><a href="#syscall-passing">Notes on syscall passing</a></li>
                    155: <li><a href="#manpage-writing">Writing a manpage</a></li>
                    156: <li><a href="#file-rename">Renaming or removing installed binaries</a></li>
                    157: <li><a href="#cleaning-tree">Cleaning your tree</a></li>
                    158: <li><a href="#weak-symbol"> When to add weak-symbol to library functions?</a></li>
                    159: <li><a href="#newyear">What files need updating on each Jan 1st?</a></li>
                    160: <li><a href="#mailinglist">What is the job of a mailing list moderator?</a></li>
1.14      dent      161: </ul>
1.47      hubertf   162: <hr>
                    163: <h3 class="title"></h3>
1.48      hubertf   164:   <h4 class="title">
                    165: <a name="about"></a>About this file (<a href="#misc-notes">top</a>)
                    166:   </h4>
                    167:   <p>
                    168: If some nugget of information is useful enough for NetBSD developers 
                    169: to know - list it here.
                    170:   </p>
                    171: 
1.47      hubertf   172: <h4 class="title">
                    173: <a name="elf-aout-align"></a>ELF vs. a.out .align (<a href="#misc-notes">top</a>)
                    174:   </h4>
1.1       abs       175: 
1.21      dent      176: <p>
1.47      hubertf   177: <span class="emphasis"><em>Klaus Klein writes:</em></span>
1.21      dent      178: Just as a short reminder for those who are about to switch over their
                    179: m68k port to ELF: the interpretation of the .align directive has
1.22      kleink    180: changed in the m68k/ELF toolchain.  While its argument is log2(alignment)
                    181: on m68k/a.out, it is now linear; I've updated the ports which have already
1.21      dent      182: been switched to reflect this.
1.47      hubertf   183: </p>
1.21      dent      184: 
1.22      kleink    185: <p>
1.23      kleink    186: (This is also true for i386, but neither for ARM ("different" vs. log2)
1.22      kleink    187: nor SPARC (both linear).)
1.47      hubertf   188: </p>
1.22      kleink    189: 
1.47      hubertf   190: <h4 class="title">
                    191: <a name="bumping-version-numbers"></a>Logs when bumping a kernel version number or an shlib_version file (<a href="#misc-notes">top</a>)
                    192:   </h4>
                    193: <p>
1.14      dent      194: When one bumps either the kernel version number or an shlib_version file, please
1.47      hubertf   195: include both the interface changed <span class="emphasis"><em>and the new version number</em></span> in the
1.14      dent      196: log message.  Otherwise it's hard to figure out what a particular version
                    197: bump means by reading the cvs log.
1.47      hubertf   198: </p>
1.14      dent      199: 
1.47      hubertf   200: <h4 class="title">
                    201: <a name="sharing-userland"></a>Sharing userland and MACHINE_ARCH (<a href="#misc-notes">top</a>)
                    202:   </h4>
                    203: <p>
1.5       abs       204: Userland should be shareable between machines of the same MACHINE_ARCH.
                    205: Some obvious issues:
1.47      hubertf   206: </p>
1.17      dent      207: 
1.71      spz       208: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                    209: <li class="listitem">MAXPARTITIONS:
1.78    ! riz       210:       Should be determined at runtime using <a href="http://netbsd.gw.com/cgi-bin/man-cgi?sysctl+3+NetBSD-6.0+i386">sysctl(3)</a>.
1.47      hubertf   211:   </li>
1.71      spz       212: <li class="listitem">Machine specific binaries, keymaps, etc.:
1.17      dent      213:       Should fail gracefully on different MACHINE types, and be included on
                    214:       all MACHINE_ARCH systems.
1.47      hubertf   215:   </li>
1.71      spz       216: <li class="listitem">Differing memory architectures:
1.17      dent      217:       In the case where the memory architectures differs sufficiently to
1.78    ! riz       218:       need different libkvm routines, they should all be included in <a href="http://netbsd.gw.com/cgi-bin/man-cgi?kvm+3+NetBSD-6.0+i386">kvm(3)</a>
1.17      dent      219:       and the version to use determined at runtime.
1.47      hubertf   220:   </li>
1.71      spz       221: <li class="listitem">disklabels and boot blocks:
1.17      dent      222:       This is the largest outstanding area to be addressed. Volunteers welcome.
1.47      hubertf   223:   </li>
                    224: </ul></div>
1.5       abs       225: 
1.47      hubertf   226: <h4 class="title">
                    227: <a name="adding-library"></a>Adding a new library (<a href="#misc-notes">top</a>)
                    228:   </h4>
                    229: <p>
1.3       abs       230: The following is intended to be a brief list of items that need to
                    231: be addressed when adding a new library to the NetBSD tree.  In the
1.47      hubertf   232: following example pathnames, <code class="code">foo</code> is the name of the library,
                    233: <code class="code">0</code> is the library's major number and <code class="code">0</code> is the library's
                    234: minor number.  A new library would normally have <code class="code">0</code> for both the
1.3       abs       235: major and minor number.
1.47      hubertf   236: </p>
1.17      dent      237: 
1.71      spz       238: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                    239: <li class="listitem">Place the source files (including header files to
1.47      hubertf   240:       be installed, Makefile and shlib_version) into a <code class="code">libfoo</code>
                    241:       directory in the CVS repository, using <span class="emphasis"><em>cvs add</em></span> or <span class="emphasis"><em>cvs
                    242:       import</em></span>, depending on which is more appropriate e.g. due to
1.17      dent      243:       external maintenance of the product.
1.47      hubertf   244:   </li>
1.71      spz       245: <li class="listitem">Add the <code class="code">libfoo</code> subdirectory to the Makefile's SUBDIRS
1.17      dent      246:       list one level up in the hierarchy.
1.47      hubertf   247:   </li>
1.71      spz       248: <li class="listitem">Add the full shared object name (<code class="code">./usr/lib/libfoo.so.0.0</code>) to
1.47      hubertf   249:       <code class="code">src/distrib/sets/lists/base/shl.mi</code>.
                    250:   </li>
1.71      spz       251: <li class="listitem">Add the PIC library (<code class="code">./usr/lib/libfoo_pic.a</code>) to
1.47      hubertf   252:       <code class="code">src/distrib/sets/lists/comp/shl.mi</code>.
                    253:   </li>
1.71      spz       254: <li class="listitem">Add the ELF shared object names with no suffix
1.47      hubertf   255:       (<code class="code">./usr/lib/libfoo.so</code>) and a single numeric suffix
                    256:       (<code class="code">./usr/lib/libfoo.so.0</code>) to
                    257:       <code class="code">src/distrib/sets/lists/base/shl.elf</code>.
                    258:   </li>
1.71      spz       259: <li class="listitem">Add the lint library (<code class="code">./usr/libdata/lint/llib-lfoo.ln</code>) to
1.47      hubertf   260:       <code class="code">src/distrib/sets/lists/comp/lint.mi</code>.
                    261:   </li>
1.71      spz       262: <li class="listitem">Add the normal library (<code class="code">./usr/lib/libfoo.a</code>),
1.47      hubertf   263:       profiled library (<code class="code">./usr/lib/libfoo_p.a</code>)
1.17      dent      264:       and any headers and manual pages to
1.47      hubertf   265:       <code class="code">src/distrib/sets/lists/comp/mi</code>.
                    266:   </li>
1.71      spz       267: <li class="listitem">Add
1.47      hubertf   268:       <pre class="programlisting">&nbsp;&nbsp;&nbsp;LIBFOO?= ${DESTDIR}/usr/lib/libfoo.a</pre>
                    269:       to <code class="code">src/share/mk/bsd.prog.mk</code> and to the DPADD
                    270:       section of <code class="code">src/share/mk/bsd.README</code>.
                    271:   </li>
1.71      spz       272: <li class="listitem">Add <code class="code">FOO</code> to the
1.47      hubertf   273:       <code class="code">__bsd_prog_mk_system_libs</code> variable in
                    274:       <code class="code">src/share/mk/bsd.hostprog.mk</code>.
                    275:   </li>
1.71      spz       276: <li class="listitem">Update the DPADD list in src/share/mk/bsd.README
1.47      hubertf   277:   </li>
1.71      spz       278: <li class="listitem">Add
1.47      hubertf   279:       <pre class="programlisting">&nbsp;&nbsp;&nbsp;.if "\\$1"libfoo" \&amp;Foo Library (libfoo, -lfoo)</pre>
                    280:       to <code class="code">src/share/tmac/doc2html</code>.
                    281:   </li>
1.71      spz       282: <li class="listitem">Add an entry to the <code class="code">.Lb libfoo</code> macro in
1.47      hubertf   283:       <code class="code">src/share/tmac/doc-syms</code>.
                    284:   </li>
1.71      spz       285: <li class="listitem">Make sure that all files have <code class="code">&#x24;NetBSD$</code> RCS
1.17      dent      286:       Ids.
1.47      hubertf   287:   </li>
1.71      spz       288: <li class="listitem">Update <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/src/doc/CHANGES?rev=HEAD&amp;content-type=text/x-cvsweb-markup">src/doc/CHANGES</a>.
1.47      hubertf   289:   </li>
                    290: </ul></div>
                    291: 
                    292: <h4 class="title">
                    293: <a name="changing-library-versions"></a>Changing the version number of a library (<a href="#misc-notes">top</a>)
                    294:   </h4>
                    295: <p>
1.1       abs       296: The minor number of a library should be incremented when it is
1.45      kano      297: possible for external programs to call any new functions or variables
1.1       abs       298: added. 
1.47      hubertf   299: </p>
                    300: 
1.1       abs       301: <p>
                    302: The major number should be incremented and the minor set to zero
                    303: when an externally visible structure changed size, or function
                    304: changed arguments. This can cause significant disruption and version
                    305: renaming is frequently used to avoid this.
1.47      hubertf   306: </p>
                    307: 
1.17      dent      308: <p>
1.38      kleink    309: With the current C ABIs changing functions (previously void) to return
                    310: a value of either integer, pointer, or floating-point type
                    311: does not necessitate incrementing the major number
                    312: since return values are always passed in (unconditionally)
                    313: caller-saved registers.  In such a case the minor number should be
                    314: incremented to note the "additions".
1.47      hubertf   315: </p>
                    316: 
1.38      kleink    317: <p>
1.17      dent      318: If you bump the major of a library, you should:
1.47      hubertf   319: </p>
1.17      dent      320: 
1.71      spz       321: <div class="orderedlist"><ol class="orderedlist" type="1">
                    322: <li class="listitem">Bump the major of any library that depends on it.
1.47      hubertf   323:   </li>
1.71      spz       324: <li class="listitem">Send mail to <code class="email">&lt;<a class="email" href="mailto:current-users@NetBSD.org">current-users@NetBSD.org</a>&gt;</code> warning about it, so
1.17      dent      325:       that if anybody's built a shared library that depends on it
                    326:       they can know to do the right thing.
1.47      hubertf   327:   </li>
1.71      spz       328: <li class="listitem">Note it in the install notes, for people upgrading to the next
1.17      dent      329:       release (or, presumably, to -current via binary snapshots).
1.47      hubertf   330:   </li>
                    331: </ol></div>
1.1       abs       332: 
1.47      hubertf   333: <h4 class="title">
                    334: <a name="syscall-passing"></a>Notes on syscall passing (<a href="#misc-notes">top</a>)
                    335:   </h4>
1.18      dent      336: <p>
1.47      hubertf   337: <span class="emphasis"><em>Christos Zoulas writes:</em></span>
1.18      dent      338: I'd like to mention for future reference, that our syscall
                    339: argument passing mechanism does not handle passing structs or unions
                    340: properly on all architectures, so syscall implementors need to
                    341: convert those to pointers and provide stubs in userland that &amp;struct
                    342: or &amp;union before calling the kernel stub.
1.47      hubertf   343: </p>
1.18      dent      344: 
1.47      hubertf   345: <h4 class="title">
                    346: <a name="manpage-writing"></a>Writing a manpage (<a href="#misc-notes">top</a>)
                    347:   </h4>
1.71      spz       348: <div class="orderedlist"><ol class="orderedlist" type="1">
1.78    ! riz       349: <li class="listitem">The <a href="http://netbsd.gw.com/cgi-bin/man-cgi?mdoc.samples+7+NetBSD-6.0+i386">mdoc.samples(7)</a> and <a href="http://netbsd.gw.com/cgi-bin/man-cgi?mdoc+7+NetBSD-6.0+i386">mdoc(7)</a> manpages are excellent for reference
1.17      dent      350:       (if a little lengthy).
1.47      hubertf   351:   </li>
1.71      spz       352: <li class="listitem">Work from the template in /usr/share/misc/mdoc.template, and
1.78    ! riz       353:       refer to an existing manpage (for example <a href="http://netbsd.gw.com/cgi-bin/man-cgi?who+1+NetBSD-6.0+i386">who(1)</a> for a command,
        !           354:       and <a href="http://netbsd.gw.com/cgi-bin/man-cgi?err+3+NetBSD-6.0+i386">err(3)</a> for a function).
1.47      hubertf   355:   </li>
1.71      spz       356: <li class="listitem">When done, remember to add the formatted
1.47      hubertf   357:       (/usr/share/man/man<span class="emphasis"><em>section</em></span>/<span class="emphasis"><em>name</em></span>.<span class="emphasis"><em>section</em></span>)
                    358:       and formatted (/usr/share/man/cat<span class="emphasis"><em>section</em></span>/<span class="emphasis"><em>name</em></span>.0)
                    359:       to <code class="code">src/distrib/sets/lists/man/mi</code>.
                    360:   </li>
                    361: </ol></div>
                    362: 
                    363: <h4 class="title">
                    364: <a name="file-rename"></a>Renaming or removing installed binaries (<a href="#misc-notes">top</a>)
                    365:   </h4>
                    366: <p>
1.9       itojun    367: If your change filename, or remove any of files installed to DESTDIR,
                    368: you will need to do something like the following.
                    369: You need to decide which list file to update,
                    370: based on the file you will be removing.
1.47      hubertf   371: </p>
1.17      dent      372: 
1.71      spz       373: <div class="orderedlist"><ol class="orderedlist" type="1">
                    374: <li class="listitem">Find the old filename (or removed filename) from
1.51      kano      375:       <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/src/distrib/sets/lists/base/mi?rev=HEAD&amp;content-type=text/x-cvsweb-markup">src/distrib/sets/lists/base/mi</a>
1.47      hubertf   376:       (or relevant file).
                    377:   </li>
1.71      spz       378: <li class="listitem">Add keyword <code class="literal">obsolete</code>
1.51      kano      379:       to the old filename (or removed filename)
                    380:       as third keyword.
1.17      dent      381:       This is for upgrade installations.
1.47      hubertf   382:   </li>
1.71      spz       383: <li class="listitem">And of course, don't forget to add new filename to
1.51      kano      384:       <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/src/distrib/sets/lists/base/mi?rev=HEAD&amp;content-type=text/x-cvsweb-markup">src/distrib/sets/lists/base/mi</a>.
1.47      hubertf   385:   </li>
                    386: </ol></div>
                    387: 
                    388: <h4 class="title">
                    389: <a name="cleaning-tree"></a>Cleaning your tree (<a href="#misc-notes">top</a>)
                    390:   </h4>
1.17      dent      391: <p>
1.47      hubertf   392: <span class="emphasis"><em>Perry E. Metzger writes:</em></span>
1.17      dent      393: At periodic intervals, I find that my checked out tree gets filled
                    394: with garbage that cvs update normally doesn't "?" because it is in the
                    395: ignored list -- stuff like .orig files from patching runs or .o files
                    396: for things that don't exist any more. Since CVS ignores them, one
                    397: never finds out one's tree has the junk in it.
1.47      hubertf   398: </p>
                    399: 
1.17      dent      400: <p>
                    401: I'm sure I'm the last person to discover this trick, but in case I'm
                    402: not, I have found that doing
1.47      hubertf   403: </p>
                    404: 
                    405: <pre class="programlisting"> cvs update -I \! -I CVS </pre>
                    406: 
1.17      dent      407: <p>
1.47      hubertf   408: nicely yields lots of good complaints about left-over garbage like
                    409: this.
                    410: </p>
1.17      dent      411: 
1.47      hubertf   412: <h4 class="title">
                    413: <a name="weak-symbol"></a> When to add weak-symbol to library functions? (<a href="#misc-notes">top</a>)
                    414:   </h4>
1.17      dent      415: <p>
1.47      hubertf   416: In short, to quote Klaus Klein:
                    417: </p>
1.17      dent      418: 
1.71      spz       419: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                    420: <li class="listitem">the identifier is to be used internally by libc, and
1.47      hubertf   421:   </li>
1.71      spz       422: <li class="listitem">the identifier is not a feature of ANSI C resp. C90.
1.47      hubertf   423:   </li>
                    424: </ul></div>
1.17      dent      425: 
                    426: <p>
1.11      itojun    427: The weak symbol reference has two goals:
1.47      hubertf   428: </p>
1.17      dent      429: 
1.71      spz       430: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                    431: <li class="listitem">Users should be allowed to define a function "foo", if "foo" is not
1.47      hubertf   432:       defined in ANSI C, and the name is used in any of OS-supplied
                    433:       library.
                    434:   </li>
1.71      spz       435: <li class="listitem">A library function may call other library functions.  In this case,
1.17      dent      436:       the call must be made safe against name collision with user-supplied
                    437:       functions.  Therefore, we need to use "_foo", not "foo",
                    438:       to refer other library functions from within the library function.
                    439:       If we call "foo", "foo" can be overridden by user-supplied function
                    440:       and may result in strange behavior.
1.47      hubertf   441:   </li>
                    442: </ul></div>
1.11      itojun    443: 
1.47      hubertf   444: <h4 class="title">
                    445: <a name="newyear"></a>What files need updating on each Jan 1st? (<a href="#misc-notes">top</a>)
                    446:   </h4>
1.25      hubertf   447: 
1.47      hubertf   448: <p>
1.25      hubertf   449: On the first of each year, the following files need to be updated
1.32      jschauma  450: to list the new year in the Copyright strings
1.47      hubertf   451: </p>
1.25      hubertf   452: 
1.71      spz       453: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                    454: <li class="listitem"> src/sys/conf/copyright
1.47      hubertf   455: </li>
1.71      spz       456: <li class="listitem"> localsrc/admin/copyright/templates/*
1.47      hubertf   457: </li>
1.71      spz       458: <li class="listitem"> htdocs/layout.xml
1.49      daniel    459: </li>
1.71      spz       460: <li class="listitem"> htdocs/about/disclaimer.xml
1.49      daniel    461: </li>
1.71      spz       462: <li class="listitem"> htdocs/docs/guide/*/netbsd.xml
1.64      jnemeth   463: </li>
1.47      hubertf   464: </ul></div>
1.25      hubertf   465: 
1.52      martin    466: <p>
1.61      jnemeth   467: In htdocs/donations, you need to add new files for the new year and
1.62      jnemeth   468: update index.xml and Makefile to build and display the new year .html file.
1.52      martin    469: </p>
                    470: 
1.68      jnemeth   471: <p>
1.69      jnemeth   472: In htdocs/docs/software/index.xml, you need to add the new year to
                    473: the "Changes to the Packages Collection" item.
1.68      jnemeth   474: </p>
                    475: 
1.70      jnemeth   476: <p>
                    477: In pkgsrc/doc, you need to add a new file for CHANGES-YYYY.
                    478: </p>
                    479: 
                    480: 
1.47      hubertf   481: <h4 class="title">
                    482: <a name="mailinglist"></a>What is the job of a mailing list moderator? (<a href="#misc-notes">top</a>)
                    483:   </h4>
1.37      jschauma  484: 
1.47      hubertf   485: <p>
                    486: A short summary by Herb Peyerl:
1.37      jschauma  487: You have to accept and read all bounce messages from the lists
                    488: you own to make sure they're not legitimate postings. You then
                    489: forward all legitimate postings that have bounced to the list
                    490: in question using the majordomo 'approve' script. You also
                    491: have to do any subscribes or unsubscribes from people whose
                    492: email addresses didn't match exactly the email address they
                    493: subscribed with.
1.47      hubertf   494: </p>
                    495: 
1.37      jschauma  496: <p>
                    497: In the case of moderated lists (-announce, -news) you need 
                    498: to make sure the postings match the charter of the list(s) 
                    499: and approve them if they are appropriate, or reply to the
                    500: author and explain why you can't approve their postings.
1.47      hubertf   501: </p>
                    502: 
1.37      jschauma  503: <p>
                    504: You'll also get keyword bounces which are usually spam (that
                    505: you have to read) and if they're legitimate postings,
                    506: determine where the keyword match was and decide whether it
                    507: was legitimate and forward it. If not, communicate back to
                    508: the author to ask him/her to rephrase their posting.
1.47      hubertf   509: </p>
                    510: 
1.37      jschauma  511: <p>
                    512: The above task becomes fairly onerous during virus season.
1.47      hubertf   513: </p>
1.54      dsieger   514: </div></div></div>
                    515: <div class="navfoot"></div>
1.67      mishka    516: <div id="footer"><div id="footerContent"><center>
1.54      dsieger   517: <span class="footfeed"><a href="http://www.NetBSD.org/cgi-bin/feedback.cgi">
                    518:          Contact</a> |
1.60      kano      519:       </span><span class="footcopy"><a href="../about/disclaimer.html">
1.54      dsieger   520:       Disclaimer</a> |
                    521: 
1.72      snj       522:       <span class="copyright">Copyright © 1994-2012 The NetBSD Foundation, Inc. </span>ALL RIGHTS RESERVED.<br>NetBSD<sup>®</sup> is a registered trademark of The NetBSD
1.54      dsieger   523:        Foundation, Inc.</span>
1.67      mishka    524: </center></div></div>
1.47      hubertf   525: </div></body>
1.1       abs       526: </html>

CVSweb <webmaster@jp.NetBSD.org>