summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2008-09-17 19:30:29 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2008-09-17 19:30:29 +0000
commit5d2c65e0bdc46677e29a66f51f3bb0d0f3bd8d18 (patch)
treeb94c3bbefc20fb6d95e19361034ad8b4b0658a7e /doc
parent2008-09-17 Joel Sherrill <joel.sherrill@oarcorp.com> (diff)
downloadrtems-5d2c65e0bdc46677e29a66f51f3bb0d0f3bd8d18.tar.bz2
2008-09-17 Joel Sherrill <joel.sherrill@oarcorp.com>
* shell/rtems.t, user/conf.t, user/stackchk.t: Rename STACK_CHECKER_ON to more appropriate CONFIGURE_STACK_CHECKER_ENABLED.
Diffstat (limited to 'doc')
-rw-r--r--doc/ChangeLog5
-rw-r--r--doc/shell/rtems.t2
-rw-r--r--doc/user/conf.t13
-rw-r--r--doc/user/stackchk.t4
4 files changed, 15 insertions, 9 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index ff53a59f0d..b99b3b8930 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,8 @@
+2008-09-17 Joel Sherrill <joel.sherrill@oarcorp.com>
+
+ * shell/rtems.t, user/conf.t, user/stackchk.t: Rename STACK_CHECKER_ON
+ to more appropriate CONFIGURE_STACK_CHECKER_ENABLED.
+
2008-09-17 Joel Sherrill <joel.sherrill@OARcorp.com>
* user/conf.t: Fix typo.
diff --git a/doc/shell/rtems.t b/doc/shell/rtems.t
index 7bf2b67c4d..11906de881 100644
--- a/doc/shell/rtems.t
+++ b/doc/shell/rtems.t
@@ -166,7 +166,7 @@ This command always succeeds and returns 0.
@subheading NOTES:
-The @code{STACK_CHECKER_ON} @code{confdefs.h} constant
+The @code{CONFIGURE_STACK_CHECKER_ENABLED} @code{confdefs.h} constant
must be defined when the application is configured for this
command to have any information to report.
diff --git a/doc/user/conf.t b/doc/user/conf.t
index 81ef4ae9cc..ceaa1ceae0 100644
--- a/doc/user/conf.t
+++ b/doc/user/conf.t
@@ -184,12 +184,13 @@ before RTEMS release 4.5.0. The miniIMFS supports
only directories and device nodes and is smaller in executable
code size than the full IMFS.
-@findex STACK_CHECKER_ON
-@item @code{STACK_CHECKER_ON} is defined when the application
-wishes to enable run-time stack bounds checking. This increases
-the time required to create tasks as well as adding overhead
-to each context switch. By default, this is not defined and
-thus stack checking is disabled.
+@findex CONFIGURE_STACK_CHECKER_ENABLED
+@item @code{CONFIGURED_STACK_CHECKER_ENABLED} is defined when
+the application wishes to enable run-time stack bounds checking.
+This increases the time required to create tasks as well as adding
+overhead to each context switch. By default, this is not defined and
+thus stack checking is disabled. NOTE: In 4.9 and older, this was named
+@code{STACK_CHECKER_ON}
@end itemize
diff --git a/doc/user/stackchk.t b/doc/user/stackchk.t
index 9ac6cf2bdf..06009f1f43 100644
--- a/doc/user/stackchk.t
+++ b/doc/user/stackchk.t
@@ -86,12 +86,12 @@ The application must include the stack bounds checker extension set
in its set of Initial Extensions. This set of extensions is
defined as @code{STACK_CHECKER_EXTENSION}. If using @code{<rtems/confdefs.h>}
for Configuration Table generation, then all that is necessary is
-to define the macro @code{STACK_CHECKER_ON} before including
+to define the macro @code{CONFIGURE_STACK_CHECKER_ENABLED} before including
@code{<rtems/confdefs.h>} as shown below:
@example
@group
-#define STACK_CHECKER_ON
+#define CONFIGURE_STACK_CHECKER_ENABLED
...
#include <rtems/confdefs.h>
@end group