CIB merge technical documentation (EN)

6. Call parameters in detail

6.5. Parameter --break

[-b]

The parameter --break shifts the time at which CIB merge stops a mixing process in case of an error.


Syntax
--break=<Abbruchniveau>
<Abbruchniveau>: all, loop, doc, par, never oder ok

Description

CIB merge aborts the processing in various situations with error messages. This occurs especially in mixing processes, for example, when a variable is used that is not defined.

In some situations, however, it is desirable that CIB merge does not terminate immediately on every error, but continues with the processing if possible. For this purpose the parameter B for break was introduced in version 3.7.62.

In order to find the position in the raw text or text module, CIB merge also outputs the subsequent errors or situations after the cause of the error. (This corresponds to a kind of "stack unrolling".) CIB merge also writes the closing brackets of the raw text, as far as the situation allows, so that the text can be opened by other applications.

<cancellation level> determines the point up to which the process is continued or aborted. The following values are possible:

Cancellation level

Description

all

always cancel, never continue (default)

loop

continue to the end of the loop, cancel it (also series and parameters)

doc

continue until end of document, cancel series (also parameters)

par

continue to the end of the series (-@), no more parameters

never

continue until all parameters are processed, no cancellation, but return error code

ok

move until all parameters are processed, no cancellation, return OK

However, CIB merge will continue to output all errors to the error log file, only with the note

 "==>continue (parameter "break" with level "XXX")"

after certain mistakes.

 

Examples
--break=loop

If the mixing run is currently in a loop, it will only run until the end after the error, i.e. will not be repeated. Immediately after this, the mixing process will be cancelled.

--break=never

CIB merge carries out the mixing job to the end regardless of any errors occurring and returns the error code of the first error that occurred.

The use of the parameter with these two example assignments is described in detail in the use case example Templates.


Note

Independently of --break=<cancellation level> all errors occurring up to the end or cancellation of the mixing process will be logged in the log file.