diff options
Diffstat (limited to 'admin/notes')
| -rw-r--r-- | admin/notes/BRANCH | 18 | ||||
| -rw-r--r-- | admin/notes/exit-value | 35 |
2 files changed, 53 insertions, 0 deletions
diff --git a/admin/notes/BRANCH b/admin/notes/BRANCH new file mode 100644 index 00000000000..2c343e53f15 --- /dev/null +++ b/admin/notes/BRANCH | |||
| @@ -0,0 +1,18 @@ | |||
| 1 | This file describes the CVS branch in which it is maintained. | ||
| 2 | Everything below the line is branch-specific. | ||
| 3 | ________________________________________________________________________ | ||
| 4 | |||
| 5 | This is the "HEAD" branch, otherwise known as the "trunk". Its primary | ||
| 6 | purpose is to accumulate changes that are not yet partitioned into a | ||
| 7 | specific (versioned) release. When people say "use CVS emacs", this is | ||
| 8 | the branch they are talking about. Likewise, a "cvs checkout" without | ||
| 9 | the "-r" option results in this branch. | ||
| 10 | |||
| 11 | The plans for this branch are not specified; Emacs hackers add to it | ||
| 12 | relatively free of constraint (aside from proper legal / accounting | ||
| 13 | practices), although sometimes there is related discussion on the | ||
| 14 | emacs-devel mailing list. | ||
| 15 | |||
| 16 | The closure process for this branch is undocumented; concepts such as | ||
| 17 | "freeze", "release", or "integration with the trunk" are not applicable | ||
| 18 | to this branch. | ||
diff --git a/admin/notes/exit-value b/admin/notes/exit-value new file mode 100644 index 00000000000..e59bb614b9b --- /dev/null +++ b/admin/notes/exit-value | |||
| @@ -0,0 +1,35 @@ | |||
| 1 | ttn 2004-05-09 | ||
| 2 | |||
| 3 | The exit value of a program returning to the shell on unixoid systems is | ||
| 4 | typically 0 for success, and non-0 (such as 1) for failure. For vms it is | ||
| 5 | odd (1,3,5...) for success, even (0,2,4...) for failure. | ||
| 6 | |||
| 7 | This holds from the point of view of the "shell" (in quotes because vms has a | ||
| 8 | different dispatch model that is not explained further here). | ||
| 9 | |||
| 10 | From the point of view of the program, nowadays stdlib.h on both type of | ||
| 11 | systems provides macros `EXIT_SUCCESS' and `EXIT_FAILURE' that should DTRT. | ||
| 12 | |||
| 13 | NB: The numerical values of these macros DO NOT need to fulfill the the exit | ||
| 14 | value requirements outlined in the first paragraph! That is the job of the | ||
| 15 | `exit' function. Thus, this kind of construct shows misunderstanding: | ||
| 16 | |||
| 17 | #ifdef VMS | ||
| 18 | exit (1); | ||
| 19 | #else | ||
| 20 | exit (0); | ||
| 21 | #endif | ||
| 22 | |||
| 23 | Values aside from EXIT_SUCCESS and EXIT_FAILURE are tricky. | ||
| 24 | |||
| 25 | |||
| 26 | |||
| 27 | ttn 2004-05-12 | ||
| 28 | |||
| 29 | Values aside from EXIT_SUCCESS and EXIT_FAILURE can be used to indicate | ||
| 30 | finer gradations of failure. If this is the only information available | ||
| 31 | to the caller, clamping such values to EXIT_FAILURE loses information. | ||
| 32 | If there are other ways to indicate the problem to the caller (such as | ||
| 33 | a message to stderr) it may be ok to clamp. In all cases, it is the | ||
| 34 | relationship between the program and its caller that must be examined. | ||
| 35 | [Insert ZAMM quote here.] | ||