Mercurial > octave-nkf
changeset 9031:1052a66078cf
Documentation cleanup of top-level Octave directory (READMEs, INSTALL)
Spellcheck README and INSTALL files.
Start all sentences with two spaces after period for readability.
| author | Rik <rdrider0-list@yahoo.com> |
|---|---|
| date | Thu, 19 Mar 2009 20:47:36 -0700 |
| parents | cda45dc441f7 |
| children | 349616d9c38e |
| files | CHECKLIST NEWS PROJECTS README README.Cray README.Cygwin README.MSVC README.kpathsea README.snapshots ROADMAP doc/interpreter/install.txi |
| diffstat | 11 files changed, 46 insertions(+), 46 deletions(-) [+] |
line wrap: on
line diff
--- a/CHECKLIST Sun Mar 15 12:15:50 2009 +0800 +++ b/CHECKLIST Thu Mar 19 20:47:36 2009 -0700 @@ -4,7 +4,7 @@ * Update the version number in src/version.h. - * Update the version number in doc/refcard.tex. + * Update the version number in doc/refcard/refcard.tex. * Add a `Version M.N.P released.' line to the ChangeLog. @@ -12,8 +12,6 @@ * Check the README file. - * Create a new Announce.M.N.P file for the current release. - * Run autoconf, autoheader, and configure before making tar files. * Update the NEWS and README.octave files in the anonymous ftp
--- a/NEWS Sun Mar 15 12:15:50 2009 +0800 +++ b/NEWS Thu Mar 19 20:47:36 2009 -0700 @@ -17,7 +17,7 @@ endfor works as expected. This capability has be used to introduce - stem-series, bar-series, etc. objects for better Matlab + stem-series, bar-series, etc., objects for better Matlab compatibility. ** New graphics functions: @@ -195,7 +195,7 @@ Octave will now attempt to share data in some cases where previously a copy would be made, such as certain array slicing operations or - conversions between cells, structs and cs-lists. This usually reduces + conversions between cells, structs and cs-lists. This usually reduces both time and memory consumption. ** Improved performance for reduction operations. @@ -230,7 +230,7 @@ Additionally, fsolve is now able to solve overdetermined systems, complex-differentiable complex systems, systems with a sparse jacobian and can work in single precision if given single precision - inputs. It can also be called recursively. + inputs. It can also be called recursively. ** Improvements to the norm function.
--- a/PROJECTS Sun Mar 15 12:15:50 2009 +0800 +++ b/PROJECTS Thu Mar 19 20:47:36 2009 -0700 @@ -80,12 +80,12 @@ endfor endfor - actually make sense. Otherwise the above will cause massive amounts + actually make sense. Otherwise the above will cause massive amounts of memory reallocation. The fact is that this doesn't make sense in any case as the assign - function makes another copy of the sparse matrix. So although spalloc - might easily be made to have the correct behaviour, the first assign + function makes another copy of the sparse matrix. So although spalloc + might easily be made to have the correct behavior, the first assign will cause the matrix to be resized! There seems to be no simple way to treat this but a complete rewrite of the sparse assignment functions... @@ -409,7 +409,7 @@ programs will become hard to program. If possible, I would like to have the virtual memory system in - Octave i.e. the all big files, the user see as one big array or + Octave i.e., the all big files, the user see as one big array or such. There could be several user selectable models to do the virtual memory depending on what kind of data the user have (1d, 2d) and in what order they are processed (stream or random @@ -422,16 +422,16 @@ Michael Smolsky <fnsiguc@weizmann.weizmann.ac.il> wrote: I was thinking about a tool, which could be very useful for me - in my numerical simulation work. It is an interconnection - between gdb and octave. We are often managing very large arrays + in my numerical simulation work. It is an interconnection + between gdb and octave. We are often managing very large arrays of data in our fortran or c codes, which might be studied with - the help of octave at the algorithm development stages. Assume + the help of octave at the algorithm development stages. Assume you're coding, say, wave equation. And want to debug the - code. It would be great to pick some array from the memory of - the code you're develloping, fft it and see the image as a - log-log plot of the spectral density. I'm facing similar + code. It would be great to pick some array from the memory of + the code you're developing, fft it and see the image as a + log-log plot of the spectral density. I'm facing similar problems now. To avoid high c-development cost, I develop in - matlab/octave, and then rewrite into c. It might be so much + matlab/octave, and then rewrite into c. It might be so much easier, if I could off-load a c array right from the debugger into octave, study it, and, perhaps, change some [many] values with a convenient matlab/octave syntax, similar to
--- a/README Sun Mar 15 12:15:50 2009 +0800 +++ b/README Thu Mar 19 20:47:36 2009 -0700 @@ -34,12 +34,12 @@ Octave requires approximately 1.5GB of disk storage to unpack and compile from source (significantly less if you don't compile with debugging symbols). Once installed, Octave requires approximately -450GB of disk space (again, considerably less if you don't build +450MB of disk space (again, considerably less if you don't build shared libraries or the binaries and libraries do not include debugging symbols). To compile Octave, you will need a recent version of GNU Make. You -will also need a recent version of g++ or other ANSI C++ compiler. +will also need a recent version of g++ or another ANSI C++ compiler. You will also need a Fortran 77 compiler or f2c. If you use f2c, you will need a script like fort77 that works like a normal Fortran compiler by combining f2c with your C compiler in a single script. @@ -60,7 +60,7 @@ Octave's manual has been revised for version 3.0, but it is lagging a bit behind the development of the software. In particular, there is currently no complete documentation of the C++ class libraries. If -you notice ommissions or inconsistencies, please report them as bugs +you notice omissions or inconsistencies, please report them as bugs to bug@octave.org. Specific suggestions for ways to improve Octave and its documentation are always welcome. Reports with patches are even more welcome.
--- a/README.Cray Sun Mar 15 12:15:50 2009 +0800 +++ b/README.Cray Thu Mar 19 20:47:36 2009 -0700 @@ -12,13 +12,13 @@ --without-blas --without-lapack --disable-readline The last to arguments tell Octave to use the reference blas and - lapack implmentation in Fortran and to not require the readline + lapack implementation in Fortran and to not require the readline library. If you have the readline library, you can omit the last option. You can also try to use a vendor library for LAPACK and BLAS, but how are those compiled? You will need a version of the library that is compiled for 64-bit double precision values, but that uses the D and Z names (I'm not sure that this is the case - with the Cray librararies). + with the Cray libraries). I'm using -O0 in an effort to speed up compilation. If you want an optimized version and have time to wait for the build to
--- a/README.Cygwin Sun Mar 15 12:15:50 2009 +0800 +++ b/README.Cygwin Thu Mar 19 20:47:36 2009 -0700 @@ -10,7 +10,7 @@ Binary version 3.0.2-2 is built with gcc-4.3.2-1 -Current cygwin octvave mantainer : +Current cygwin octvave maintainer : Marco Atzeri http://matzeri.altervista.org
--- a/README.MSVC Sun Mar 15 12:15:50 2009 +0800 +++ b/README.MSVC Thu Mar 19 20:47:36 2009 -0700 @@ -266,9 +266,9 @@ 3. Installation =============== -The compiled Octave is relocatable. This means that whetever +The compiled Octave is relocatable. This means that whatever installation dir you chose at configure time, you can move the whole -installation directory to another location without any problem. Octave +installation directory to another location without any problem. Octave should still run OK.
--- a/README.kpathsea Sun Mar 15 12:15:50 2009 +0800 +++ b/README.kpathsea Thu Mar 19 20:47:36 2009 -0700 @@ -60,10 +60,10 @@ the corresponding numbers. `KPSE_DEBUG_STAT (1)' - Report `stat'(2) calls. This is useful for verifying that your + Report `stat'(2) calls. This is useful for verifying that your directory structure is not forcing Kpathsea to do many additional file tests (*note Slow path searching::., and *note Subdirectory - expansion::.). If you are using an up-to-date `ls-R' database + expansion::.). If you are using an up-to-date `ls-R' database (*note Filename database::.), this should produce no output unless a nonexistent file that must exist is searched for. @@ -75,15 +75,15 @@ instead of using `ls-R'. `KPSE_DEBUG_FOPEN (4)' - Report file openings and closings. Especially useful when your + Report file openings and closings. Especially useful when your system's file table is full, for seeing which files have been - opened but never closed. In case you want to set breakpoints in a + opened but never closed. In case you want to set breakpoints in a debugger: this works by redefining `fopen' (`fclose') to be `kpse_fopen_trace' (`kpse_fclose_trace'). `KPSE_DEBUG_PATHS (8)' Report general path information for each file type Kpathsea is - asked to search. This is useful when you are trying to track down + asked to search. This is useful when you are trying to track down how a particular path got defined--from `texmf.cnf', `config.ps', an environment variable, the compile-time default, etc. This is the contents of the `kpse_format_info_type' structure defined in @@ -91,7 +91,7 @@ `KPSE_DEBUG_EXPAND (16)' Report the directory list corresponding to each path element - Kpathsea searches. This is only relevant when Kpathsea searches + Kpathsea searches. This is only relevant when Kpathsea searches the disk, since `ls-R' searches don't look through directory lists in this way. @@ -127,9 +127,9 @@ programs. Debugging output from Kpathsea is always written to standard error, -and begins with the string `kdebug:'. (Except for hash table buckets, +and begins with the string `kdebug:'. (Except for hash table buckets, which just start with the number, but you can only get that output -running under a debugger. See comments at the `hash_summary_only' +running under a debugger. See comments at the `hash_summary_only' variable in `kpathsea/db.c'.) Logging @@ -145,7 +145,7 @@ to if it does. Each successful search turns into one line in the log file: two words -separated by a space. The first word is the time of the search, as the +separated by a space. The first word is the time of the search, as the integer number of seconds since "the epoch", i.e., UTC midnight 1 January 1970 (more precisely, the result of the `time' system call). The second word is the filename.
--- a/README.snapshots Sun Mar 15 12:15:50 2009 +0800 +++ b/README.snapshots Thu Mar 19 20:47:36 2009 -0700 @@ -74,7 +74,7 @@ /pub/gnu. Even though the snapshots are available in a public place, we ask that -recipients not widely publicise the availability of the snapshots. +recipients not widely publicize the availability of the snapshots. The motivation for this request is not to hoard them, but to avoid the situation where the general Octave user base naively attempts to use the snapshots, has trouble with them, complains publicly, and the
--- a/ROADMAP Sun Mar 15 12:15:50 2009 +0800 +++ b/ROADMAP Thu Mar 19 20:47:36 2009 -0700 @@ -64,7 +64,7 @@ test -- tests for the interpreter config * configuration files for DejaGnu - octave.test * subdirectories contianing actual tests are here + octave.test * subdirectories containing actual tests are here John W. Eaton
--- a/doc/interpreter/install.txi Sun Mar 15 12:15:50 2009 +0800 +++ b/doc/interpreter/install.txi Thu Mar 19 20:47:36 2009 -0700 @@ -34,8 +34,9 @@ Free Software Foundation. @strong{Note:} This file is automatically generated from -@file{doc/interpreter/install.txi} in the Octave sources, so to make -changes to this documentation file, change that source file. +@file{doc/interpreter/install.txi} in the Octave sources. To update +the documentation make changes to the .txi source file rather than this +derived file. @node Installation @chapter Installing Octave @@ -157,18 +158,19 @@ @item --without-framework-opengl Don't use framework OpenGL headers, libraries and specific source code -for compilation even if the configure test succeeds. If this option is +for compilation even if the configure test succeeds. If this option is given then OpenGL headers and libraries in standard system locations are -tested (the default value is @code{--with-framework-opengl}). This is a +tested (the default value is @code{--with-framework-opengl}). This is a platform specific configure option for Mac systems. @item --help Print a summary of the options recognized by the configure script. @end table -See the file @file{INSTALL} for more information about the command line -options used by configure. That file also contains instructions for -compiling in a directory other than where the source is located. +See the file @file{INSTALL} for more general information about the +command line options used by configure. That file also contains +instructions for compiling in a directory other than where the source +is located. @item Run make. @@ -184,7 +186,7 @@ any but the most peripheral sense. To compile Octave, you will need a recent version of GNU Make. You will -also need a recent version of @code{g++} or other ANSI C++ compiler. You +also need a recent version of @code{g++} or other ANSI C++ compiler. You will also need a Fortran 77 compiler or @code{f2c}. If you use @code{f2c}, you will need a script like @code{fort77} that works like a normal Fortran compiler by combining @code{f2c} with your C compiler in @@ -202,7 +204,7 @@ @url{ftp.gnu.org} is available by anonymous ftp from @url{ftp://ftp.gnu.org/pub/gnu/GNUinfo/FTP}. -You will need about 925 megabytes of disk storage to work with when +You will need about 1 gigabyte of disk storage to work with when building Octave from source (considerably less if you don't compile with debugging symbols). To do that, use the command @@ -372,7 +374,7 @@ @noindent to match the prototype declaration for the @code{signal} function. This change should also be made for the @code{SIG_DFL} and @code{SIG_ERR} -symbols. It may be necessary to change the definitions in +symbols. It may be necessary to change the definitions in @file{sys/signal.h} as well. The @code{gcc} @code{fixincludes} and @code{fixproto} scripts should