$set 1
$ Copyright 06/06/96 Sun Microsystems, Inc. All Rights Reserved
$ 
$ @(#)cflow_msg.txt 1.4 96/06/06 SMI
$ 
$ NOTE: The "-#" lead-in character must be followed by a space to be recognized
$ as a comment line.  All comment lines must begin with "-# ".
$ 
$ 
$ This file is used to create the .msg file, .h header files, and
$ on-line help files needed to process messages in acomp, alint, acpp, & ssbd
$  
$ The file has the following format:
$ 
$ <--> <severity> [<#msgno>] <msg-tag> <brief error-text>
$ <-[> <sanitized brief error-text>
$ <++> <error explanation help text>
$ <-+> <verbose error-text>
$ <-#> <comment>
$ <-@> <testname path>
$ 
$ The 'lead-in' characters denote the following:
$ 
$ 	'--'	:	Normal (standard) error text.  like what C++ has now
$ 	'-['	:	Error text with all %<symbol> fields replaced 
$ 	'++'	:	Error explanation help text.
$ 	'-+'	:	Verbose error text
$ 	'-#'	:	Error source file comments
$ 	'-@'	:	Comment documenting testname which stress this message
$ 
$ The 'lead-in' characters must be followed by a space or tab character,
$ including comment lines '-#'.  The fields <severity> <#msgno> <msg-tag>
$ <brief error-text> must be seperated by only one space or tab character.
$ 
$ The five entries are matched sets.  All text between '--' pairs is
$ considered a set assigned to <msg-tag>.  The entries for '-[', '++',
$ '-+', '-#', '-@' are optional.  The 'lead-in' characters must be present in
$ the first column only and only for the first line of text for each
$ subset member.  To be recognized as 'lead-in' characters they must
$ begin in column one and must be immediately followed by a space or tab
$ character.  The subset members '--', '-[', '-#' and '-@' consist of single
$ line entries only, all other subset members can consist of multiple lines.
$ There is one order dependency, that is that the '++' line(s) must
$ follow the '-[' line.  The ordering here is for implementation
$ convenience, it simplifies the building of the explanation help text
$ files.
$ 
$ The fields '--' 'severity' 'msg-tag' must all be on the same line.
$ The field 'severity' consists of a single digit integer.  The fields
$ '-[' 'sanitized brief error-text' must be on the same line.  The fields
$ 'brief error-text' 'sanitized brief error-text' 'error explanation help
$ text' 'verbose error-text' 'comment' are all considered to begin with
$ second character following the field (or lead-in characters) that is
$ required to precede them.  This means if you start the fields 'error
$ explanation help text' 'verbose error-text' 'comment' with a newline
$ they will begin with a newline character.  This is done by placing a
$ newline character, '\n', after the required space or tab character
$ following the lead-in characters '++', '-+', or '-#', e.g. "++ \n".
$ 
$ msg-tags must adhear to these naming rules:
$ The must consist of uppercase letters (A-Z) and the 
$ character underscore (_).  They must begin with an uppercase letter.
$ 
$ They are limited to 31 characters in length
$ 
$ They must be unique
$ 
$ Try to make them represent the message they tag, they are
$ likely to become visable to the end user
$ 
$ When used in the help files the underscores will be converted to hyphens
$ 
$ 'severity' is a number and is defined as a severity level for use by
$ the compiler, currently this is unsed and should be set to 1.
$ 
$ '#msgno' is generated automatically by the assignmsgno utility.
$ #msgno should NEVER BE ADDED OR EDITED BY HAND.  When a new message
$ is added it should be added with a new error text line as follows:
$ 
$ <--> <severity> <msg-tag> <brief error-text>
$ 
$ 
$ ######################################################################
$ 
$ Message order is no longer important.  Messages can be moved and
$ grouped.  Permanent message numbers are assigned by the utility
$ assignmsgno.  The target which assigns message numbers in the acomp
$ Makfile.common should only be run by the buildmaster or C project lead
$ at each point when a message file may be shipped off for localization.
$ These might include:  viability, alpha, beta, FCS slush dates and patch
$ builds.  Never assign message numbers by hand.
$ 
$     Do Not remove an error, instead add a comment following it saying:
$  DELETED MESSAGE - The above message is no longer used
$  However, the help text for the message should be removed along
$       with the sanitized brief error text "-[" line.  Only the
$       message "--" line and "-# DELETED MESSAGE" line should remain.
$     Do Not reuse messages
$  Remember they may be used in more than one place
$     Do Not reword a message.  If wording changes are neccessary add
$  a comment line to the original message saying:
$       DELETED MESSAGE - The above message is no longer used
$       and add a new message with the correct wording and move
$  the help text from the old message to the new message, reworded
$  appropriately
$     Typos may be fixed.  However, they must also be fixed in the
$     appropriate chkpt.msg file, so that compmsg will not complain.
$     No other changes should be made to chkpt.msg file by hand!
$ 
$ Start all error messages with E_
$ 
$ If you need a leading space, begin the message with a space
$ i.e. the message starts with the second character following the
$ 	msg-tag.
$ For trailing spaces, just add them to the end,
$   add a comment that the trailing spaces are important
$ 
$ Add comment on all messages that do not need explanation text
$ 
1 Message catalog %s/%s installed.\n
$ No explanation text needed for above message, not an error message
$  
$ ######################################################################
$  
2 dag: bad option %c ignored\n
$  
3 bad type to typr: %ld\n
$  
4 lpfx: Intermediate file string format error\n
$  
5 lpfx: bad option %c ignored\n
$  
6 lpfx: out of heap space\n
$  
7 lpfx: out of space\n
$  
8 out of heap space\n
$  
9 out of space\n
$  
10 redefinition of %s\n
$  
11 too many links\n
$  
12 too many nodes
$  
13 too many characters\n


