Magellan Linux

  • Back to homepage
    • /[magellan-source]/trunk/mkinitrd-magellan/busybox/docs/contributing.txt

    Diff of /trunk/mkinitrd-magellan/busybox/docs/contributing.txt

    Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

    revision 983 by niro, Sat Sep 1 22:45:15 2007 UTC revision 984 by niro, Sun May 30 11:32:42 2010 UTC
    # Line 17  help. However, before you dive in, headl Line 17  help. However, before you dive in, headl
    17  you need to do:  you need to do:
    18    
    19    
    20  Checkout the Latest Code from CVS  Checkout the Latest Code
    21  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~  ~~~~~~~~~~~~~~~~~~~~~~~~
    22    
    23  This is a necessary first step. Please do not try to work with the last  This is a necessary first step. Please do not try to work with the last
    24  released version, as there is a good chance that somebody has already fixed  released version, as there is a good chance that somebody has already fixed
    25  the bug you found. Somebody might have even added the feature you had in mind.  the bug you found. Somebody might have even added the feature you had in mind.
    26  Don't make your work obsolete before you start!  Don't make your work obsolete before you start!
    27    
    28  For information on how to check out Busybox from CVS, please look at the  For information on how to check out Busybox development tree, please look at the
    29  following links:  following links:
    30    
    31   http://busybox.net/cvs_anon.html   http://busybox.net/source.html
      http://busybox.net/cvs_howto.html  
    32    
    33    
    34  Read the Mailing List  Read the Mailing List
    # Line 87  Knife" of embedded Linux, there are some Line 86  Knife" of embedded Linux, there are some
    86     we do not want to start adding mkfs/fsck tools for every (or any)     we do not want to start adding mkfs/fsck tools for every (or any)
    87     filesystem under the sun. (fsck_minix.c and mkfs_minix.c are living on     filesystem under the sun. (fsck_minix.c and mkfs_minix.c are living on
    88     borrowed time.) There are far too many of these tools out there.  Use     borrowed time.) There are far too many of these tools out there.  Use
    89     the upstream version. Not everything has to be part of Busybox.     the upstream version.  Rationale: bugs in these tools can destroy
    90       vast amounts of data.  Keeping up with filesystem format development
    91   - Any partitioning tools: Partitioning a device is typically done once and     is impractical (especially in the area of keeping fsck tool safe
    92     only once, and tools which do this generally do not need to reside on the     and up-to-date).
        target device (esp a flash device). If you need a partitioning tool, grab  
        one (such as fdisk, sfdisk, or cfdisk from util-linux) and use that, but  
        don't try to merge it into busybox. These are nasty and complex and we  
        don't want to maintain them.  
    93    
    94   - Any disk, device, or media-specific tools: Use the -utils or -tools package   - Any disk, device, or media-specific tools: Use the -utils or -tools package
    95     that was designed for your device; don't try to shoehorn them into Busybox.     that was designed for your device; don't try to shoehorn them into Busybox.
    # Line 103  Knife" of embedded Linux, there are some Line 98  Knife" of embedded Linux, there are some
    98     independent. Do not send us tools that cannot be used across multiple     independent. Do not send us tools that cannot be used across multiple
    99     platforms / arches.     platforms / arches.
    100    
      - Any daemons that are not essential to basic system operation. To date, only  
        syslogd and klogd meet this requirement. We do not need a web server, an  
        ftp daemon, a dhcp server, a mail transport agent or a dns resolver. If you  
        need one of those, you are welcome to ask the folks on the mailing list for  
        recommendations, but please don't bloat up Busybox with any of these.  
       
    101    
    102  Bug Reporting  Bug Reporting
    103  ~~~~~~~~~~~~~  ~~~~~~~~~~~~~
    # Line 135  an example: Line 124  an example:
    124      But when I use BusyBox date I get this instead:      But when I use BusyBox date I get this instead:
    125    
    126   $ date   $ date
    127   llegal instruction   Illegal instruction
    128    
    129      I am using Debian unstable, kernel version 2.4.19-rmk1 on an Netwinder,      I am using Debian unstable, kernel version 2.4.19-rmk1 on an Netwinder,
    130      and the latest uClibc from CVS.  Thanks for the wonderful program!      and the latest uClibc from CVS.
    131    
    132   -Diligent   -Diligent
    133    
    # Line 199  Janitorial Work Line 188  Janitorial Work
    188    
    189  These are dirty jobs, but somebody's gotta do 'em.  These are dirty jobs, but somebody's gotta do 'em.
    190    
      - Converting applets to use getopt() for option processing. Type 'find -name  
        '*.c'|grep -L getopt' to get a listing of the applets that currently don't  
        use getopt. If a .c file processes no options, it should have a line that  
        reads: /* no options, no getopt */ somewhere in the file.  
       
      - Replace any "naked" calls to malloc, calloc, realloc, str[n]dup, fopen with  
        the x* equivalents found in libbb/xfuncs.c.  
       
    191   - Security audits:   - Security audits:
    192     http://www.securityfocus.com/popups/forums/secprog/intro.shtml     http://www.securityfocus.com/popups/forums/secprog/intro.shtml
    193    
    # Line 235  These are dirty jobs, but somebody's got Line 216  These are dirty jobs, but somebody's got
    216    
    217  Other useful links:  Other useful links:
    218    
    219   - the comp.lang.c FAQ: http://web.onetelnet.ch/~twolf/tw/c/index.html#Sources   - the comp.lang.c FAQ: http://home.datacomm.ch/t_wolf/tw/c/index.html#Sources
    220    
    221    
    222    
    Legend:
    Removed from v.983  
    changed lines
      Added in v.984