Including Source Files

The exercises typically require that you create or modify one or more C source files. You must include these source files, or relevant fragments of them in the Development section of your report. You should clearly delimit such files or fragments in the report (so that the program or fragment can be clearly distinguished from the text of the report proper), and explain exactly what they are. Here is an example:

        This is the program BDAY.C . It is a modified version of
        the program XMAS.C from page 4063 of the textbook. It prints a
        birthday greeting.

        --------------------------------------------

        /* BDAY.C */

        #include <safe-c.h>

        int main(void)
        {
          put_string("Happy Birthday!!!");
        }

        --------------------------------------------

Note that, using PFE to edit the report, you can easily use the Copy and Paste facilities (on the Edit menu) to copy from one subwindow to another.

Where you have created a new source file from scratch during the Lab session you should include the complete file in the report. Where you have only modified, or augmented, some given file then you should only include the modified parts, or the additions, in the report. You have to exercise some judgement here. The basic principle is that the report is a report on your work, so you omit anything which was already done for you; but you may have to bend this rule somewhat in order to provide enough context for the report to be understandable. In any case, the surrounding text of the report should make it clear what you have included, and why.

Typically you will be developing one or more source files as the Lab progresses (correcting, debugging, enhancing etc.). So a natural question is whether you should separately include every single variant in your report. Again, this requires some judgement. The general principle is that the report should definitely contain the "final" versions of any relevant source file(s) - i.e. as they were when you finished working on them. This is true regardless of whether this "final" version is actually functional or not.

In addition to such final versions, the report should also contain earlier versions (or fragments of earlier versions) where that is useful or necessary to illustrate some significant problem or difficulty you encountered. This will be discussed further below.