[Prev][Next][Index][Thread]

Re: Notes for porters



On Thu, 14 Sep 1995, Paul Hepworth wrote:

> Sounds like a good idea.  Anything I do will include comments on
> what I changed and why.  If it is a new source file, why and where it fits into
> the overall source scheme will be documented in comments.  If we all do the
> same, it will be easy for someone to compile these comments into a series of 
> porting notes.  We might want to flag all such comments in a consistent way so
> that tools may easily extract the applicable comments.  Maybe /* OJ:  .... */
> or /* java2:  ... */.
> Opinions, please.
> 
> 
> Paul

Definitely.  I like /* JAVA/2: ... */ personally.  This might be to early
to talk about some of this, but we need to start thinking about this
stuff.

Like, we should try to bracket changed code with #ifdef OS2 and #else
statements where possible, so that the code will remain commonly
compilable with other platforms.  Where changes are too great and would
cause a mess, I would suggest dup'ing the file and doing something like:

/* original.c */

#ifdef OS2
#include "os2_alternate_file.c"
#else
 ... the original source file ...
#endif

This of course assumes we want to try to maintain a common base with the
Sun code.  I think it's cleaner, though a little more work, but Sun might
appreciate it.  For what it's worth, it makes for really nice diffs as
well.  Feedback?

=========================================================================
Brett Wooldridge | "I believe OS/2 is destined to be the most important
brettw@io.com    | operating system, and possibly program, of all time." 
                 \____                                  -- Bill Gates
IBM Taligent Team     \
brettw@austin.ibm.com | Amiga3K-NetBSD <=== ethernet ===> 486/100Mhz-Warp
=========================================================================



Follow-Ups: References: