Submitting Laboratory Exercises

CSC 213 - Operating Systems and Parallel Algorithms - Weinman

Summary:

Methods for preparing to submit laboratory exercises

1. The first four or more lines of any C program should be comments containing your name, your mailbox number, an identification of assignment being solved, and a description of the contents of the file. For example:

   /* Jerod Weinman  

    * Box: Science

    * Lab 1: Review of C

    * arraylib.c: Definitions of useful functions to manipulate arrays

   */

   Remember that a comment is also required for every definition of a C function, stating the purpose of the program unit in English.
2. Obtain a nicely formatted PDF listing of your source code using the enscript(1) command:

   $ enscript -p - -Ec -2 -r --color source.c ...  |  ps2pdf - prettysource.pdf

   where prettysource.pdf is the name of the file in which you want the formatted source code stored (enscript generates a PostScript file, which you will pipe to ps2pdf(1) for conversion to PDF.) If your work involves several C files, list the primary program first, then list any supplementary files. Multiple source files can be placed in one call to enscript. While you may also use a wildcard such as *.c be sure this only includes the files requested for the particular assignment.
3. As appropriate, create a transcript of your program's compilation and output runs using the script(1) command:
   1. In a terminal window, start recording output to a file called transcript with the command:

      $ script transcript
   2. Compile your program with gcc or make as appropriate.
   3. Run your program with appropriate test cases to verify its correctness.
   4. When your runs are complete, stop the script session by typing Ctrl-D.
   5. Convert the recorded text file to a nice, printable PDF file using enscript(1):

      $ enscript -p - -2 -r  transcript  |  ps2pdf - transcript.pdf

      where transcript is the name of the recording file you created above, and the .pdf file is the printable version enscript(1) creates.
4. Concatenate (merge) your program source, transcript, and report etc.

   $ pdfconcat -o submission.pdf prettysource.pdf transcript.pdf
5. If the assignment a PDF and source files, create an archive of your source files and PDF for electronic submission. For example,

   $ tar cf submission.tar submission.pdf source.c ...

   where submission.tar is the name of the archive file you want your files stored in. You may list as many source files on the line as you wish, or even use a wildcard (*.c) Please be sure you do not include any intermediate PDF files or urequested source files.
6. One group member should submit an electronic version of the archive (submission.tar from above, or submission.pdf if no source files are required) online via PioneerWeb by the due date. Be sure you allow enough time to construct your submission before the deadline.

Note:

PioneerWeb requires one final step after uploading your file to complete the submission process. Please make sure you complete it! (Otherwise it is marked as "in progress" and I cannot retrieve it.) Failure to complete the submision process in a timely fashion will result in the usual late penalties.

Reminder:

Be sure you upload the correct file. (Uploading the wrong lab tar file happens more often than you might think and than I would like.) Take care with your work. Failure to upload the correct lab file will also result in the usual late penalties.

• You should not include transcripts with excessive amounts of output (use your judgment)
• If your archive contains no PDF (when requested), your submission may not get printed or graded. I make no guarantees to notice this in a timely fashion, but if I catch the omission and contact you, the standard late penalties for a revised submission will apply.

Acknowledgments