#docexit

[mentalisttraceur-software]

docexit

This doesn't come up nearly as often as "docerr" for me, because most programs can reasonably just exit with success or failure and save all specificity for stderr, but I have a similar little touch for a program to document its exit statuses in help text.

For example, a diff program could use this section in its help text like this:

Exits:

    0 if the input files are the same

    1 if the input files differ

    2 if there was an error

And for ssh it would look like this:

Exits:

    0-255 exit status of the remote command

    255 if there was an error in ssh

I personally would include this whenever the conventional expectations of exit behavior would be wrong or misleading.