SDP-503
Closed
SDP Guide mentions some scripts by most of the filename, not all of it.
For example, SDP_Guide.Unix.pdf provides a brief explanation of recreate_offline_db, live_checkpoint and daily_checkpoint, but the actual files are called recreate_offline_db.sh, live_checkpoint.sh and daily_checkpoint.sh. As it's possible to have files with no 'extension' (no '.sh' in this case) please ensure the full name is used: searching the doc for "daily_checkpoint.sh" finds a few places where the script is mentioned, but does not find section 5.1.6 "daily_checkpoint" where the explanation of the purpose is found. The reader either needs to review the Table of Contents to see if it's mentioned, or assumes the script is not documented at all.
For example, SDP_Guide.Unix.pdf provides a brief explanation of recreate_offline_db, live_checkpoint and daily_checkpoint, but the actual files are called recreate_offline_db.sh, live_checkpoint.sh and daily_checkpoint.sh. As it's possible to have files with no 'extension' (no '.sh' in this case) please ensure the full name is used: searching the doc for "daily_checkpoint.sh" finds a few places where the script is mentioned, but does not find section 5.1.6 "daily_checkpoint" where the explanation of the purpose is found. The reader either needs to review the Table of Contents to see if it's mentioned, or assumes the script is not documented at all.
- Status
- Closed
- Project
- perforce-software-sdp
- Severity
- C
- Reported By
- Adam Morriss
- Reported Date
- Modified By
- Robert Cowham
- Modified Date
- Owned By
- mtorkington
- Component
- doc
- Type
- Bug