|
|
@@ -80,29 +80,30 @@ The following files comprise the build system: |
|
|
|
(e.g. SNFMilter), and which extra files are to be part of the |
|
|
|
distribution (e.g. BUGS, README, etc). |
|
|
|
|
|
|
|
3) Makefile.am in each directory: SNFMilter, SNFClient, SNF2Check, |
|
|
|
CodeDweller, SNFMulti, Scripts, Tests, and config_files. These are |
|
|
|
used to create the Makefile files for building, configuring and |
|
|
|
installing the software. These Makefile.am files contain lists |
|
|
|
which source files are to be used for building, and directions to |
|
|
|
generate the configuration files. |
|
|
|
3) Makefile.am in each directory: binary/SNFMilter, |
|
|
|
binary/SNFClient, binary/SNF2Check, binary/SNFMilterConfig, Scripts, |
|
|
|
Tests, and config_files. These are used to create the Makefile |
|
|
|
files for building, configuring and installing the software. These |
|
|
|
Makefile.am files contain lists which source files are to be used |
|
|
|
for building, and directions to generate the configuration files. |
|
|
|
|
|
|
|
In addition, the distribution includes the source files and |
|
|
|
configuration files for each of the applications. |
|
|
|
|
|
|
|
During the build process, the files in SNFMulti and CodeDweller are |
|
|
|
compiled into a static library. The applications SNFMulti, SNFClient, |
|
|
|
and SNF2Check link with these libraries. This library is not |
|
|
|
installed. The system checks the dates of the files, and recompiles |
|
|
|
and relinks as necessary. |
|
|
|
During the build process, the binary/<AppName> directories (where |
|
|
|
<AppName> is the name of the executable) are populated with the object |
|
|
|
files and executable. The system checks the dates of the files, and |
|
|
|
recompiles and relinks as necessary. |
|
|
|
|
|
|
|
To add an additional source file , edit the appropriate Makefile.am. |
|
|
|
To add an additional source file, edit the appropriate Makefile.am. |
|
|
|
Add the source file to the appropriate variable. For example, in |
|
|
|
SNFMilter/Makefile.am: |
|
|
|
binary/SNFMilter/Makefile.am: |
|
|
|
|
|
|
|
1) SNFMilter_SOURCES for the cpp files for SNFMilter. |
|
|
|
|
|
|
|
2) noinst_HEADERS for the header files for SNFMilter. These are |
|
|
|
In the top-level Makefile.am: |
|
|
|
|
|
|
|
2) noinst_HEADERS for any header files for SNFMilter. These are |
|
|
|
part of the user tarball, but aren't installed into the user system. |
|
|
|
|
|
|
|
Note that files that are not listed will not be included in the |
|
|
@@ -144,19 +145,6 @@ the parameters for the ./configure command for each OS): |
|
|
|
|
|
|
|
make OTHER_CXXFLAGS='-Wall' |
|
|
|
|
|
|
|
Issue the following command for running the unit tests: |
|
|
|
|
|
|
|
1) make check |
|
|
|
|
|
|
|
This builds and executes the test programs in the Tests directory. |
|
|
|
The test programs are named TestXXXXX, and the source file is |
|
|
|
TestXXXXX.cpp, where XXXXX is a string descriptive of the test |
|
|
|
(e.g. TestMailHeaders and TestMailHeaders.cpp). The test program is |
|
|
|
run with no command-line inputs, and returns 0 for success, and |
|
|
|
non-zero for failure. The "make check" command runs all the unit |
|
|
|
tests, and summarizes how many tests the software passed and how many |
|
|
|
tests the software failed. |
|
|
|
|
|
|
|
The "./configure" command configures the system for installation into |
|
|
|
the default directories, or the directories specified in the |
|
|
|
command-line options. The default directory '/usr/local', and can be |
|
|
@@ -406,17 +394,6 @@ messages to other systems (e.g. the system log, or standard output). |
|
|
|
The messages are logged using snf_RulebaseHandler::logThisInfo() or |
|
|
|
snf_RulebaseHandler::logThisError(). The Code input is always 1. |
|
|
|
|
|
|
|
Testing |
|
|
|
------- |
|
|
|
|
|
|
|
The unit tests test the MailHeaders class. Run the unit tests by |
|
|
|
executing "make check". |
|
|
|
|
|
|
|
The test plan and procedures are summarized in |
|
|
|
Docs/TestPlanProcXXX.odt. The code to assist in executing the test |
|
|
|
procedures is in Tests/TestProcedures. Please read the README file in |
|
|
|
that directory for further information. |
|
|
|
|
|
|
|
Packages |
|
|
|
-------- |
|
|
|
|