patch: fixes in the doc
Akim Demaille <[email protected]> Wed, 7 Apr 2010 15:22:26 +0200
| Newsgroups | gmane.comp.gnu.aspell.devel |
|---|---|
| Message-ID | <[email protected]> |
Hi, I don't know if this list is being used, the archives are quite empty. It's hard to understand where Aspell is, there are bits in Savannah, in Sourceforge, etc. It's unclear where suggestions and patches should be sent (I have others waiting for this one to pass). Is there any plan to move away from CVS? Début du message réexpédié : > De : Akim Demaille <[email protected]> > Date : 6 avril 2010 13:44:45 HAEC > À : [email protected] > Objet : aspell: fixes in the doc > > Hi, > > I suggest the following patch, against the CVS repository. Do you have something other than CVS to work on Aspell? > > Cheers! > > 2010-04-06 Akim Demaille <[email protected]> > > * aspell.texi: Use @option to document options, in particular > to avoid `--' being compiled as a single dash as per standard > Texinfo rules. > > _______________________________________________ Aspell-devel mailing list [email protected] http://lists.gnu.org/mailman/listinfo/aspell-devel
01-fix-options-in-doc.patch
(application/octet-stream, 3 KB)
? manual/ChangeLog
? manual/Makefile.in
? manual/aspell-dev.info
? manual/aspell.info
? manual/texinfo.tex
Index: manual/aspell.texi
===================================================================
RCS file: /sources/aspell/aspell/manual/aspell.texi,v
retrieving revision 1.83
diff -w -u -r1.83 aspell.texi
--- manual/aspell.texi 19 Oct 2007 06:23:23 -0000 1.83
+++ manual/aspell.texi 6 Apr 2010 11:43:51 -0000
@@ -321,7 +321,7 @@
check and @code{@var{options}} is any number of optional options. Some of
the more useful ones include:
-@table @b
+@table @option
@item --mode=@var{mode}
the mode to use when checking files. The available modes are
@code{none}, @code{url}, @code{email}, @code{sgml}, @code{tex},
@@ -710,11 +710,11 @@
To enable a boolean option simply specify the option without any
corresponding value, or prefix it with an @samp{enable-}. For example
-to create a backup file use @samp{--backup}. To disable a boolean
+to create a backup file use @option{--backup}. To disable a boolean
option prefix the option name with a @samp{dont-} or @samp{disable-}.
-To avoid creating a backup file use @samp{--dont-backup}. Boolean options
+To avoid creating a backup file use @option{--dont-backup}. Boolean options
can also be set directly like a value option where the value is either
-"true" or "false", for example @samp{--backup=true}.
+"true" or "false", for example @option{--backup=true}.
If a boolean option has a single letter abbreviation simply give the
letter corresponding to either enabling or disabling the option
@@ -726,18 +726,18 @@
To add a value to the list, prefix the option name with an
@samp{add-} and then specify the value to add. For example, to add
-the URL filter use @samp{--add-filter url}. To remove a value from
+the URL filter use @option{--add-filter url}. To remove a value from
a list option, prefix the option name with a @samp{rem-} and then
specify the value to remove. For example, to remove the URL filter use
-@samp{--rem-filter url}. To remove all items from a list prefix the
+@option{--rem-filter url}. To remove all items from a list prefix the
option name with a @samp{clear-} without specify any value. For
-example, to remove all filters use @samp{--clear-filter}.
+example, to remove all filters use @option{--clear-filter}.
A list option can also be set directly, in which case it will be set to
a single value. To directly set a list option to multiple values prefix
the option name with a @samp{lset-} and separate each value with a
@samp{:}. For example, to use the URL and TeX filter use
-@samp{--lset-filter url:tex}.
+@option{--lset-filter url:tex}.
@subsection Via a Configuration File
@@ -5291,8 +5291,10 @@
information of what I have in store.
@item
-Added some options to the configure script: --enable-dict-dir=DIR,
---enable-doc-dir=DIR, --enable-debug, and --enable-opt
+Added some options to the configure script:
+@option{--enable-dict-dir=\var{dir}},
+@option{--enable-doc-dir=\var{dir}}, @option{--enable-debug}, and
+@option{--enable-opt}
@item
Removed some old header files.