view SENDING-PATCHES @ 10791:3140cb7a05a1

Add spellchecker scripts for Octave and run spellcheck of documentation interpreter/doccheck: New directory for spelling/grammar scripts. interpreter/doccheck/README: Instructions for using scripts. interpreter/doccheck/spellcheck: Script to spellcheck a Texinfo file. interpreter/doccheck/aspell.conf: GNU Aspell configuration file for Octave documentation. interpreter/doccheck/aspell-octave.en.pws: Private Aspell dictionary. interpreter/doccheck/add_to_aspell_dict: Script to add new Octave-specific words to private Aspell dictionary. interpreter/octave.texi: New @nospell macro which forces Aspell to ignore the word marked by the macro. interpreter/mk_doc_cache.m: Skip new @nospell macro when building doc_cache.
author Rik <octave@nomad.inbox5.com>
date Sat, 17 Jul 2010 19:53:01 -0700
parents 12ff450cbb1f
children
line wrap: on
line source

[This was originally from Richard Stallman who was writing about
 Emacs.  --jwe]

A reminder for those sending patches for Octave:

  * Always make the diffs with context.  Preferably use diff -c.  It
    is unreliable to install a diff without context, and therefore we
    probably will not take the risk of trying; instead we will
    probably ask you to send a context diff.  You might as well send
    that in your first message.

  * Always send change log entries with your patches.  Itemize the
    entries so that they list each of the functions and variables
    changed.  Look at the ChangeLog files and follow our conventions
    regarding what information to include and what style to use.

  * If the patch is to fix a bug, send a detailed bug report for the
    bug.  Make this just as detailed as if you did not have any fix
    for it.  This information is vital for convincing the maintainer
    that your fix is necessary and should be installed.  Also, if your
    fix would cause some other sort of problem, the bug report may
    enable the maintainer to find some other correct fix.

Everyone, please read the Bugs chapter in the Octave manual to see
other guidelines on how to write a bug report that makes it possible
to fix a bug.