about summary refs log tree commit diff
path: root/Src
diff options
context:
space:
mode:
Diffstat (limited to 'Src')
-rw-r--r--Src/Builtins/rlimits.c7
1 files changed, 7 insertions, 0 deletions
diff --git a/Src/Builtins/rlimits.c b/Src/Builtins/rlimits.c
index aa9b9dd48..5f9c84b0f 100644
--- a/Src/Builtins/rlimits.c
+++ b/Src/Builtins/rlimits.c
@@ -50,6 +50,13 @@ typedef struct resinfo_T {
 } resinfo_T;
 
 /* table of known resources */
+/*
+ * How to add a new resource:
+ * 1. Add zsh_LIMIT_PRESENT(RLIMIT_XXX) in configure.ac.
+ * 2. Add an entry for RLIMIT_XXX to known_resources[].
+ *    Make sure the option letter (resinto_T.opt) is unique.
+ * 3. Build zsh and run the test B12rlimit.ztst.
+ */
 static const resinfo_T known_resources[] = {
     {RLIMIT_CPU, "cputime", ZLIMTYPE_TIME, 1,
 		't', "cpu time (seconds)"},