Changeset e392fdb7 in rtems-libbsd for libbsd.txt


Ignore:
Timestamp:
Mar 9, 2012, 5:18:06 PM (8 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.11, c1e05b9ea378b2971e3d7704779112b4bc4296da, freebsd-9.3, 4a77611a223ea883fb548679b516d326a020d447
Children:
455aa3a
Parents:
8f5adbc
Message:

Documentation additions.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • libbsd.txt

    r8f5adbc re392fdb7  
    1414modifications to the FreeBSD source are permitted.
    1515
     16Goals of this effort are:
     17
     18* Update TCP/IP and provide USB in RTEMS
     19* Ease updating to future FreeBSD versions
     20* Ease tracking changes in FreeBSD code
     21* Minimize manual changes in FreeBSD code
     22* Define stable kernel/device driver API which is implemented
     23by both RTEMS and FreeBSD. This is the foundation of the port.
     24
     25We will work to push our changes upstream to the FreeBSD Project
     26and minimize changes required at each update point.
     27
    1628**************************************************************
    1729This is a work in progress and is very likely to be incomplete.
     
    2739  - BSP must be from an architecture with Programmable Interrupt Controller
    2840    interrupt model.
     41
     42The FreeBSD 8.2 SVN checkout will generally be referred to as the
     43FreeBSD source in this document.
    2944
    3045== To Do
     
    7994currently working on.
    8095
    81 
    8296=== Organization
    8397
     
    93107* libbsd.txt - Documentation in Asciidoc
    94108
     109== Moving Code Between FreeBSD SVN and RTEMS libbsd
     110
     111The script freebsd-to-rtems.py is used to copy code from FreeBSD to the
     112RTEMS libbsd tree and to reverse this process. This script attempts to
     113automate this process as much as possible and performs some transformations
     114on the FreeBSD code. Its command line arguments are shown below:
     115
     116[listing]
     117----
     118freebsd-to-rtems.py [args]
     119  -?|-h|--help     print this and exit
     120  -d|--dry-run     run program but no modifications
     121  -e|--early-exit  evaluate arguments, print results, and exit
     122  -m|--makefile    just generate Makefile
     123  -R|--reverse     default FreeBSD -> RTEMS, reverse that
     124  -r|--rtems       RTEMS directory
     125  -f|--freebsd     FreeBSD directory
     126  -v|--verbose     enable verbose output mode
     127----
     128
     129In its default mode of operation, freebsd-to-rtems.py is used to copy code
     130from FreeBSD to the RTEMS libbsd tree and perform transformations.  In forward
     131mode, the script may be requested to just generate the Makefile.
     132
     133In "reverse mode", this script undoes those transformations and copies
     134the source code back to the FreeBSD SVN tree. This allows us to do
     135'svn diff', evaluate changes made by the RTEMS Project, and report changes
     136back to FreeBSD upstream.
     137
     138In either mode, the script may be asked to perform a dry-run or be verbose.
     139Also, in either mode, the script is also smart enough to avoid copying over
     140files which have not changed. This means that the timestamps of files are
     141not changed unless the contents change. The script will also report the
     142number of files which changed. In verbose mode, the script will print
     143the name of the files which are changed.
     144
     145The following is an example forward run with no changes.
     146
     147[listing]
     148----
     149$ ~/newbsd/git/libbsd-8.2/freebsd-to-rtems.py \
     150    -r /home/joel/newbsd/git/libbsd-8.2 \
     151    -f /home/joel/newbsd/libbsd/freebsd-8.2 -v
     152Verbose:                yes
     153Dry Run:                no
     154Only Generate Makefile: no
     155RTEMS Directory:        /home/joel/newbsd/git/libbsd-8.2
     156FreeBSD Directory:      /home/joel/newbsd/libbsd/freebsd-8.2
     157Direction:              forward
     158Generating into /home/joel/newbsd/git/libbsd-8.2
     1590 files were changed.
     160----
     161
Note: See TracChangeset for help on using the changeset viewer.