lint formatting fixes

This commit is contained in:
William Sandner
2018-08-23 19:23:45 +02:00
parent bbf98a0dde
commit 7e0a90c44e
43 changed files with 667 additions and 455 deletions

View File

@@ -1,10 +1,10 @@
##### Project:
::[PROJECTNAME](Home)
##### Project
::[PROJECT-NAME](Home)
##### Release(s):
::X.Y.Z
##### Related Documents:
##### Related Documents
- [Software Requirements Specification](SRS)
- [Release notes](Release-Notes)
- [FAQ](FAQ)
@@ -82,7 +82,7 @@ These objects may be referred to by name in the sections below.*
#### Configuration Files
- ::PRODUCTNAME.conf: stores application configuration in Java properties file format.
- ::PRODUCT-NAME.conf: stores application configuration in Java properties file format.
- ::Section of httpd.conf: configures components of the Apache webserver
#### Database Table
@@ -95,17 +95,17 @@ These objects may be referred to by name in the sections below.*
#### Data Files
- ::*.ext: Data files saved by the user on their local hard disk.
- ::/var/PRODUCTNAME/upload-XXXX.dat: Files uploaded to the server.
- ::/var/PRODUCT-NAME/upload-XXXX.dat: Files uploaded to the server.
#### Temporary Files
- ::/tmp/PRODUCTNAME.pid: Process ID of the currently running server process.
- ::/tmp/PRODUCT-NAME.pid: Process ID of the currently running server process.
- ::/tmp/upload-XXXX.dat: Files uploaded to the server before they are processed.
#### Log Files
- ::error.log: Serious errors are put in the normal Apache error log. Must be writable by Unix user httpd.
- ::PRODUCTNAME.log: Messages indicating the progress of normal operations and some errors. Must be writable by Unix user httpd.
- ::PRODUCT-NAME.log: Messages indicating the progress of normal operations and some errors. Must be writable by Unix user httpd.
- ::Log files are rotated nightly. Old logs are archived in ANOTHER LOCATION.
### Implementation of Specific Features
@@ -116,16 +116,16 @@ impact the work of other groups. E.g., long-running operations that must
not be interrupted. E.g., start up or shutdown scripts that are
automatically run by the operating system.*
- ::Feature name: 1-3 SENTENCE DESCRIPTION
- ::Feature name: 1-3 SENTENCE DESCRIPTION
- ::Feature name: 1-3 SENTENCE DESCRIPTION
- ::DETAILS
- ::DETAILS
- ::DETAILS
- ::Feature name: 1-3 SENTENCE DESCRIPTION
- ::DETAILS
- ::DETAILS
- ::DETAILS
- ::Feature name: 1-3 SENTENCE DESCRIPTION
- ::Feature name: 1-3 SENTENCE DESCRIPTION
- ::Feature name: 1-3 SENTENCE DESCRIPTION
- ::DETAILS
- ::DETAILS
- ::DETAILS
- ::Feature name: 1-3 SENTENCE DESCRIPTION
- ::DETAILS
- ::DETAILS
- ::DETAILS
### Operational Procedures
@@ -133,30 +133,37 @@ automatically run by the operating system.*
engineers when the system is being run in an ASP production environment.*
#### Install
::See the [installation guide](Installation-Guide)
#### Upgrade
::See the [installation guide](Installation-Guide)
#### Start Server
1. ::STEP 1
2. ::STEP 2
3. ::STEP 3
#### Stop Server
1. ::STEP 1
2. ::STEP 2
3. ::STEP 3
3. ::STEP 3D-DIAGRAM
#### Reload Config Files
1. ::STEP 1
2. ::STEP 2
3. ::STEP 3
#### Monitor Activity
::Watch the PRODUCTNAME.log and error.log.
::Watch the PRODUCT-NAME.log and error.log.
#### Periodic Cleanup
::On rare occasion, /tmp/upload-XXXX.dat files can be left behind. Any such files that are more than a day old can safely be removed.
### Security
@@ -165,11 +172,13 @@ engineers when the system is being run in an ASP production environment.*
system secure while it is in operation.*
We take the following precautions to make the system secure
- ::STEP
- ::STEP
- ::STEP
The security of the system depends on the following external factors
- ::STEP
- ::STEP
- ::STEP