From bug-octave-request at bevo dot che dot wisc dot edu Mon Nov 24 14:51:17 2003 Subject: Unidentified subject! From: Glenn Golden To: bug-octave at bevo dot che dot wisc dot edu, gdg@tpad.zplane.com Date: Mon, 24 Nov 2003 13:50:52 -0700 To: bug-octave at bevo dot che dot wisc dot edu Cc: gdg Subject: Documentation added for 'global' keyword in 'clear' command Bug report for Octave 2.1.50 configured for i686-pc-linux-gnu Description: ----------- * Description of 'global' keyword semantics is missing from the help string of the 'clear' command, as per 23-Nov-03 item from help-octave list, with subject line "Re: Puzzled about scope/existence of globals" Repeat-By: --------- * N/A Fix: --- * Attached patch (against 2.1.50) attempts to document use of 'global' keyword as I understand it. I'm not sure that what I stated is actually correct, so it should be gone over carefully. NOTE: Some of original text was also modified, so the entire patched text should be checked, not just the new parts pertaining to 'global'. ====== begin patch ===== *** variables.cc Mon Nov 24 13:46:18 2003 --- ORIG/variables.cc Mon Nov 24 13:45:43 2003 *************** do_matlab_compatible_clear (const string *** 1861,1880 **** DEFCMD (clear, args, , "-*- texinfo -*-\n\ at deffn {Command} clear [-x] pattern @dots{}\n\ ! at deffnx {Command} clear [-x] global pattern @dots{}\n\ ! When called without the `global' keyword, `clear' deletes the visible\n\ ! names matching the given patterns from the symbol table of the top level\n\ ! workspace. Global variables may be cleared in this way -- that is,\n\ ! without using the at code{global} keyword -- and after doing so they will\n\ ! no longer be visible in the top level workspace; however, their\n\ ! existence in function workspaces is unaffected.\n\ ! \n\ ! When called with the `global' keyword, `clear' deletes the global\n\ ! variables matching the given patterns from the global symbol table.\n\ ! Globals cleared in this way no longer exist in any workspace.\n\ ! \n\ ! Patterns for matching variable names use the following special\n\ ! characters:\n\ \n\ at table @code\n\ at item ?\n\ --- 1861,1868 ---- DEFCMD (clear, args, , "-*- texinfo -*-\n\ at deffn {Command} clear [-x] pattern @dots{}\n\ ! Delete the names matching the given patterns from the symbol table. The\n\ ! pattern may contain the following special characters:\n\ \n\ at table @code\n\ at item ?\n\ *************** clear foo b*r\n\ *** 1898,1923 **** \n\ at noindent\n\ clears the name at code{foo} and all names that begin with the letter\n\ ! at code{b} and end with the letter @code{r} from the top level workspace.\n\ \n\ ! If at code{clear} is invoked without the @code{global} keyword, but with\n\ ! additional arguments specifying variable patterns, then only the visible\n\ names matching the arguments are cleared. For example, suppose you have\n\ defined a function at code{foo}, and then hidden it by performing the\n\ ! assignment at code{foo = 2}. Executing the command @code{clear foo} once\n\ ! will clear the variable definition and restore the definition of at code{foo}\n\ ! as a function. Executing at code{clear foo} a second time will clear the\n\ ! function definition.\n\ ! \n\ ! If at code{clear} is invoked without the @code{global} keyword and without any\n\ ! additional arguments, all user-defined variables (local and global)\n\ ! are cleared from the symbol table of the top level workspace.\n\ ! \n\ ! If invoked as at code{clear global} but without additional arguments,\n\ ! then all global variables are deleted from all workspaces.\n\ \n\ ! The -x option specifies that variables not matching the patterns\n\ ! should be cleared, in accordance with the above rules.\n\ \n\ This command may not be used within a function body.\n\ at end deffn") --- 1886,1904 ---- \n\ at noindent\n\ clears the name at code{foo} and all names that begin with the letter\n\ ! at code{b} and end with the letter @code{r}.\n\ \n\ ! If at code{clear} is called without any arguments, all user-defined\n\ ! variables (local and global) are cleared from the symbol table. If\n\ ! at code{clear} is called with at least one argument, only the visible\n\ names matching the arguments are cleared. For example, suppose you have\n\ defined a function at code{foo}, and then hidden it by performing the\n\ ! assignment at code{foo = 2}. Executing the command @kbd{clear foo} once\n\ ! will clear the variable definition and restore the definition of\n\ ! at code{foo} as a function. Executing @kbd{clear foo} a second time will\n\ ! clear the function definition.\n\ \n\ ! With -x, clear the variables that don't match the patterns.\n\ \n\ This command may not be used within a function body.\n\ at end deffn") ====== end patch ===== Configuration (please do not edit this section): ----------------------------------------------- uname output: Linux tpad 2.4.18 #6-GDG11 Sun Feb 16 10:37:50 MST 2003 i686 unknown configure opts: '--enable-shared' '--enable-dl' '--enable-lite-kernel' Fortran compiler: g77 FFLAGS: -O F2C: F2CFLAGS: FLIBS: -L/usr/lib/gcc-lib/i386-redhat-linux/2.96 -L/usr/lib/gcc-lib/i386-redhat-linux/2.96/../../.. -lg2c -lm CPPFLAGS: INCFLAGS: -I. -I. -I./liboctave -I./src -I./libcruft/misc -I./glob -I./glob C compiler: gcc, version 2.96 20000731 (Red Hat Linux 7.3 2.96-112) CFLAGS: -g -O2 CPICFLAG: -fPIC C++ compiler: g++, version 2.96 CXXFLAGS: -g -O2 -Wall CXXPICFLAG: -fPIC LD_CXX: g++ LDFLAGS: -g LIBFLAGS: -L. RLD_FLAG: -Wl,-rpath -Wl,/usr/local/lib/octave-2.1.50 BLAS_LIBS: -llapack -lblas FFTW_LIBS: LIBS: -lreadline -lncurses -ldl -lm LEXLIB: LIBPLPLOT: LIBDLFCN: LIBGLOB: ./glob/glob.o ./glob/fnmatch.o SED: /bin/sed DEFS: -DPACKAGE_NAME="" -DPACKAGE_TARNAME="" -DPACKAGE_VERSION="" -DPACKAGE_STRING="" -DPACKAGE_BUGREPORT="" -DOCTAVE_SOURCE=1 -DSTDC_HEADERS=1 -DHAVE_SYS_TYPES_H=1 -DHAVE_SYS_STAT_H=1 -DHAVE_STDLIB_H=1 -DHAVE_STRING_H=1 -DHAVE_MEMORY_H=1 -DHAVE_STRINGS_H=1 -DHAVE_INTTYPES_H=1 -DHAVE_STDINT_H=1 -DHAVE_UNISTD_H=1 -DSEPCHAR=1 -DSEPCHAR_STR=":" -D__NO_MATH_INLINES=1 -DCXX_NEW_FRIEND_TEMPLATE_DECL=1 -DCXX_ABI=gnu_v2 -DHAVE_LIBM=1 -DF77_FUNC(name,NAME)=name ## _ -DF77_FUNC_(name,NAME)=name ## __ -DHAVE_BLAS=1 -DHAVE_GETHOSTNAME=1 -DHAVE_GETPWNAM=1 -DHAVE_DEV_T=1 -DHAVE_INO_T=1 -DHAVE_NLINK_T=1 -DHAVE_NLINK_T=1 -DHAVE_LONG_LONG_INT=1 -DHAVE_UNSIGNED_LONG_LONG_INT=1 -DHAVE_SIGSET_T=1 -DHAVE_SIG_ATOMIC_T=1 -DSIZEOF_SHORT=2 -DSIZEOF_INT=4 -DSIZEOF_LONG=4 -DSIZEOF_LONG_LONG=8 -DHAVE_ALLOCA_H=1 -DHAVE_ALLOCA=1 -DNPOS=std::string::npos -DHAVE_DYNAMIC_AUTO_ARRAYS=1 -DSTDC_HEADERS=1 -DHAVE_DIRENT_H=1 -DTIME_WITH_SYS_TIME=1 -DHAVE_SYS_WAIT_H=1 -DHAVE_ASSERT_H=1 -DHAVE_CURSES_H=1 -DHAVE_DLFCN_H=1 -DHAVE_FCNTL_H=1 -DHAVE_FLOAT_H=1 -DHAVE_GRP_H=1 -DHAVE_LIMITS_H=1 -DHAVE_MEMORY_H=1 -DHAVE_NCURSES_H=1 -DHAVE_POLL_H=1 -DHAVE_PWD_H=1 -DHAVE_STDLIB_H=1 -DHAVE_STRING_H=1 -DHAVE_SYS_IOCTL_H=1 -DHAVE_SYS_PARAM_H=1 -DHAVE_SYS_POLL_H=1 -DHAVE_SYS_RESOURCE_H=1 -DHAVE_SYS_SELECT_H=1 -DHAVE_SYS_STAT_H=1 -DHAVE_SYS_TIME_H=1 -DHAVE_SYS_TIMES_H=1 -DHAVE_SYS_TYPES_H=1 -DHAVE_SYS_UTSNAME_H=1 -DHAVE_TERMCAP_H=1 -DHAVE_UNISTD_H=1 -DHAVE_VARARGS_H=1 -DHAVE_SSTREAM=1 -DHAVE_TERMIO_H=1 -DHAVE_SGTTY_H=1 -DHAVE_GLOB_H=1 -DHAVE_FNMATCH_H=1 -DHAVE_ATEXIT=1 -DHAVE_BASENAME=1 -DHAVE_BCOPY=1 -DHAVE_BZERO=1 -DHAVE_DUP2=1 -DHAVE_ENDGRENT=1 -DHAVE_ENDPWENT=1 -DHAVE_EXECVP=1 -DHAVE_FCNTL=1 -DHAVE_FORK=1 -DHAVE_GETCWD=1 -DHAVE_GETEGID=1 -DHAVE_GETEUID=1 -DHAVE_GETGID=1 -DHAVE_GETGRENT=1 -DHAVE_GETGRGID=1 -DHAVE_GETGRNAM=1 -DHAVE_GETPGRP=1 -DHAVE_GETPID=1 -DHAVE_GETPPID=1 -DHAVE_GETPWENT=1 -DHAVE_GETPWUID=1 -DHAVE_GETTIMEOFDAY=1 -DHAVE_GETUID=1 -DHAVE_GETWD=1 -DHAVE_KILL=1 -DHAVE_LINK=1 -DHAVE_LOCALTIME_R=1 -DHAVE_LSTAT=1 -DHAVE_MEMMOVE=1 -DHAVE_MKDIR=1 -DHAVE_MKFIFO=1 -DHAVE_MKSTEMP=1 -DHAVE_ON_EXIT=1 -DHAVE_PIPE=1 -DHAVE_POLL=1 -DHAVE_PUTENV=1 -DHAVE_RAISE=1 -DHAVE_READLINK=1 -DHAVE_RENAME=1 -DHAVE_RINDEX=1 -DHAVE_RMDIR=1 -DHAVE_SELECT=1 -DHAVE_SETGRENT=1 -DHAVE_SETPWENT=1 -DHAVE_SETVBUF=1 -DHAVE_SIGACTION=1 -DHAVE_SIGLONGJMP=1 -DHAVE_SIGPENDING=1 -DHAVE_SIGPROCMASK=1 -DHAVE_SIGSUSPEND=1 -DHAVE_STAT=1 -DHAVE_STRCASECMP=1 -DHAVE_STRDUP=1 -DHAVE_STRERROR=1 -DHAVE_STRFTIME=1 -DHAVE_STRNCASECMP=1 -DHAVE_STRPTIME=1 -DHAVE_SYMLINK=1 -DHAVE_TEMPNAM=1 -DHAVE_UMASK=1 -DHAVE_UNLINK=1 -DHAVE_USLEEP=1 -DHAVE_VFPRINTF=1 -DHAVE_VSPRINTF=1 -DHAVE_VSNPRINTF=1 -DHAVE_WAITPID=1 -DHAVE_LIBDL=1 -DHAVE_DLOPEN=1 -DHAVE_DLSYM=1 -DHAVE_DLERROR=1 -DHAVE_DLCLOSE=1 -DHAVE_DLOPEN_API=1 -DENABLE_DYNAMIC_LINKING=1 -DHAVE_TIMEVAL=1 -DHAVE_FINITE=1 -DHAVE_ISNAN=1 -DHAVE_ISINF=1 -DHAVE_COPYSIGN=1 -DHAVE_ACOSH=1 -DHAVE_ASINH=1 -DHAVE_ATANH=1 -DHAVE_ERF=1 -DHAVE_ERFC=1 -DHAVE_STRUCT_STAT_ST_BLKSIZE=1 -DHAVE_STRUCT_STAT_ST_BLOCKS=1 -DHAVE_STRUCT_STAT_ST_RDEV=1 -DHAVE_STRUCT_TM_TM_ZONE=1 -DHAVE_TM_ZONE=1 -DUSE_READLINE=1 -DEXCEPTION_IN_MATH=1 -DRETSIGTYPE=void -DSYS_SIGLIST_DECLARED=1 -DHAVE_SYS_SIGLIST=1 -DHAVE_POSIX_SIGNALS=1 -DHAVE_GETRUSAGE=1 -DHAVE_TIMES=1 -DYYTEXT_POINTER=1 -DGNUPLOT_BINARY="gnuplot" -DGNUPLOT_HAS_FRAMES=1 ------------------------------------------------------------- Octave is freely available under the terms of the GNU GPL. Octave's home on the web: http://www.octave.org How to fund new projects: http://www.octave.org/funding.html Subscription information: http://www.octave.org/archive.html -------------------------------------------------------------