Patch: prezip-bin info/man file for 0.61

[aspell-helper]

Jose Da Silva josedasilva\@sf created a patch on 2005-07-23 06:35:12 UTC (Orig. from https://sourceforge.net/p/aspell/patches/115)

Hopefully did this correctly.

Makefile.am appears to apply for both 0.60 and 0.61.

prezip-bin.1.61 for 0.61 includes options -l -c -d -v

prezip-bin.1.60 for 0.60 excludes options above.

[aspell-helper]

Jose Da Silva josedasilva\@sf commented on 2005-07-23 06:51:06 UTC

corrected makefile.am.diff Makefile.am.diff

[aspell-helper]

Jose Da Silva josedasilva\@sf commented on 2005-07-24 00:03:00 UTC

Logged In: YES user_id=1138138

added prezip-bin.1 which is a bit "feature-rich". Comment on it, suggest modifications, other?

[aspell-helper]

Jose Da Silva josedasilva\@sf commented on 2005-07-28 09:25:56 UTC

Logged In: YES user_id=1138138

Final refinements. Not changing 60 or 61 any further unless you specify.

thanks.

[aspell-helper]

Kevin Atkinson kevina\@sf updated the issue on 2005-08-14 19:53:03 UTC

• assigned_to: nobody --> kevina

[aspell-helper]

Kevin Atkinson kevina\@sf commented on 2005-08-30 08:50:54 UTC

Logged In: YES user_id=6591

For the '-z' option the "This is the compression..." is unnecessary. Also please use http://aspell.net as Aspell home page.

Also I rather not document the precise error codes as I don't want people to relay on them. Non-zero on error is as specific as I want to get. You can explain what the error messages mean, however. That section should probably be named DIAGNOSTICS.

Also, This informatoin should make its way into the info manual in some form.

[aspell-helper]

Kevin Atkinson kevina\@sf commented on 2005-08-31 02:38:27 UTC

Logged In: YES user_id=6591

The '-z' comment is primary for the 0.60 version. For Aspell 0.61 it is proabaly OK since it can do both versions.

[aspell-helper]

Jose Da Silva josedasilva\@sf commented on 2005-09-05 07:51:27 UTC

Logged In: YES user_id=1138138

Removed error codes as requested but did not add a diagnostic area since it is somewhat ambiguous without the precision of error codes.

Moved part of description to Tips since it seems to belong better there.

Changed "options" to "command" since it is a must-have versus being an extra.

Added minor adjustments done along the way since 07-28.

[aspell-helper]

Kevin Atkinson kevina\@sf commented on 2005-09-06 09:27:37 UTC

Logged In: YES user_id=6591

What is wrong with describing error messages without specifying the exact return values? The information is still useful for someone trying to figure out what went wrong. Also you should at least mention that it will return 0 on success and non-zero on error?

[aspell-helper]

Jose Da Silva josedasilva\@sf commented on 2005-09-07 08:13:14 UTC

Logged In: YES user_id=1138138

An error is what you end-up having "after" doing a process incorrectly or if a problem happened along the way. An error is a result.

You "begin" to diagnose a problem after a problem happened. Diagnosing is searching for a solution.

Diagnostic just doesn't seem the right word to use to describe the errors that happened and after doing a brief search of other man pages, I didn't really find a substitute for Diagnostic, so it needs more thought.

From a programmer's perspective, whether it is error codes or error messages written in a manual, it can be seen as your commitment to a stable error reporting method. You don't want to commit to error codes, and I don't think latching onto error messages is a good idea at all. 0 is still 0 in whatever language you choose, but an error message is not the same in English, french, German....etc.

In terms of Error codes, Error messages or Diagnostic maybe it is just better to leave the error codes and messages out of the brief manual pages all together. Maybe they belong in the large manual instead.

[aspell-helper]

Kevin Atkinson kevina\@sf commented on 2005-09-08 06:58:35 UTC

Logged In: YES user_id=6591

The word "Diagnostic" comes from the "grep" manual. I think it is appropriate.

You should at least mention somewhere that it will return 0 on successa and non-zero on error.

[aspell-helper]

Jose Da Silva josedasilva\@sf commented on 2005-09-10 08:02:50 UTC

Logged In: YES user_id=1138138

Looked at grep.

Also including modifications for latest aspell-0.61/prog/prezip-bin so that usage displays correctly to stderr (on error) or to stdout (on help).

[aspell-helper]

Jose Da Silva josedasilva\@sf commented on 2005-09-18 01:33:23 UTC

Logged In: YES user_id=1138138

Added a diff file to improve prezip.c so that the usage message gets sent to stderr.

Otherwise the diagnostic has to be changed for prezip-bin.1 for version .60.x so that this: ---------------- (display help/usage message) Unknown command given on the command line so prezip-bin displays a usage message to standard error output. ---------------- won't refer to stderr.

hopefully, the diff file is also accepted since it adds some better consistency of sending errors/messages to stderr instead of stdout.

[aspell-helper]

Jose Da Silva josedasilva\@sf commented on 2005-10-01 00:07:36 UTC

Logged In: YES user_id=1138138

Simplified the info/man files by removing references to unicode or wide-character compression to Keep It Simple (K.I.S.) for the user.

The references to unicode & wide-characters is probably a premature suggestion to the end-user which is maybe better to be left out for now.

Maybe better to create an option (eg: -u8 , -u16, -u32) in future so that prezip-bin allows embedded or in unicode16/32 combinations versus leaving it up to the user to watch-out for unexpected combinations on their own when using the -z command.

Separated the -l into an option instead of keeping it together with the commands for info for prezip-bin for branch 0.61

[aspell-helper]

Jose Da Silva josedasilva\@sf commented on 2005-10-01 00:07:36 UTC

05-09-30, removed unicode references prezip-bin.1.60

[aspell-helper]

Jose Da Silva josedasilva\@sf commented on 2005-12-11 04:20:59 UTC

Logged In: YES user_id=1138138

Updated prezip-bin.1 for main branch (ver 0.61). (see prezip-bin.1.main)

Removed "links" to word-list-compress and refer to it in past-tense for version 0.61 (main). It appears that word-list-compress is no longer to be packaged with aspell 0.61.x

Hopefully this allows this bug-patch to get closed finally.

---------------------- I noticed that 0.60.4 did not include suggested prezip.60.3.diff patch to redirect errors to stderr.

There is also prezip.c.diff for main branch too.

I think that the prezip.c updates could be applied so that normal help goes to stdout and actual error messages are sent to stderr, for example, a wrong command-line option:

prezip -a <wordlist.cwl | aspell blah,blah

will display a visible error if done by hand, or at least notify an automated script which watches stderr for possible errors.

on the other hand without the patch, using an unknown command will simply send the "help message" to the next process instead of displaying it or allowing a process watching stderr to do something about it.

Last but not least, it makes the 1st paragraph of diagnostics true, in which errors go to stderr and help goes to stdout (note ver1.x of prezip has no -h command so it is always an error).

Hopefully this makes sense why the patches for the C programs are included here.

Thanks

[aspell-helper]

Kevin Atkinson kevina\@sf commented on 2007-10-11 19:27:43 UTC

Logged In: YES user_id=6591 Originator: NO

What gives you the impression that word-list-compress is no longer to be packaged with aspell 0.61.x?

[aspell-helper]

Jose Da Silva josedasilva\@sf commented on 2007-10-11 20:39:37 UTC

Logged In: YES user_id=1138138 Originator: YES

Wordlist-compress still exists in the 0.60.? branch http://cvs.savannah.gnu.org/viewvc/aspell/aspell/prog/?pathrev=rel_0_60_5 Wordlist-compress is no longer in MAIN (which I think is the next version) http://cvs.savannah.gnu.org/viewvc/aspell/aspell/prog/?pathrev=MAIN

Even the scripts have been modified to use prezip-bin in MAIN: http://cvs.savannah.gnu.org/viewvc/aspell/aspell/scripts/prezip?revision=1.5&view=markup&pathrev=MAIN

It's also in your TODO list: http://cvs.savannah.gnu.org/viewvc/aspell/aspell/TODO-0.61?revision=1.9&view=markup&pathrev=MAIN

Earlier emails basically pointed in that direction as well. I would dig-up some emails mentioning more, but I don't keep mail that long and it's really not that important anyways. Project directions are not cast in stone.

Glad to see you've tackled/cleared a couple of patches. Thanks!

[aspell-helper]

Kevin Atkinson kevina\@sf commented on 2007-10-11 20:55:31 UTC

Logged In: YES user_id=6591 Originator: NO

word-list-compress is now a symbolic link to prezip-bin

Please attach a SINGLE diff of the changes that should still apply to Aspell 0.61.

[aspell-helper]

Jose Da Silva josedasilva\@sf commented on 2007-10-20 06:29:01 UTC

Logged In: YES user_id=1138138 Originator: YES

hopefully this helps: ----------------- "prezip.60.3.diff prezip.c diff for version 0.60.3 to stderr" Deleted this download since I assume you are not likely making a 0.60.6 but are going from 0.60.5 directly into version 0.61.x. This patch was meant to allow the 1st generation prezip.c (in 0.60.x) to send errors to stderr while sending "help" to stdout. -----------------

"prezip-bin.1.60 05-09-30, removed unicode references" Have to leave this as-is here because it was what you used in the 0.60.x branch. CVS does not refer to this patch for branch 60.x ----------------- "Makefile.am.diff corrected makefile.am.diff" Have to leave this as-is here because it was what you used in the 0.60.x branch. CVS does not refer to this patch for branch 60.x -----------------

This leaves only 2 files for the 0.61 branch: "prezip-bin.1.main no "word-list-compress" links in main branch" This includes the extra options in the 2nd generation prezip (in 0.61 branch) which are not present in the 1st generation prezip-bin (0.60.x branch) -----------------

"prezip.c.diff prezip-bin modification for stderr/stdout" This includes a suggested change but I don't know if you want to include it or not. It modifies output so that help->stdout and errors->stderr

*********************

word-list-compress is now a symbolic link to prezip-bin I'm not sure how to do a "ln -s prezip-bin word-list-compress" in the configure file but that is needed to replace word-list-compress.

I haven't checked 0.61 yet due to other stuff keeping me busy at the moment. :-( Hope the above info helps.

[aspell-helper]

Kevin Atkinson kevina\@sf commented on 2007-10-20 06:39:48 UTC

Logged In: YES user_id=6591 Originator: NO

Not much.

I still plan to release Aspell 0.60.6. If you want me to apply something to that branch send me A SINGLE patch of the changes still needed.

I will also wait until you send me a SINGLE patch for Aspell 0.61 before I apply anything to cvs head.

[aspell-helper]

Jose Da Silva josedasilva\@sf commented on 2007-10-28 07:43:15 UTC

Logged In: YES user_id=1138138 Originator: YES

Updated and moved prezip.c.diff patch to location: [ 1821509 ] Prezip-bin modification for stderr/stdout

[Note: #​1821509 = https://sourceforge.net/p/aspell/patches/152/ = #423]

[aspell-helper]

Jose Da Silva josedasilva\@sf commented on 2007-10-28 08:52:55 UTC

Logged In: YES user_id=1138138 Originator: YES

Prezip-bin.1 for version 0.61 was separated, and then moved + updated to location: [ 1821518 ] prezip-bin.1 info/man file for 0.61 since it is a true 0.61 patch. Hopefully everything is separated and cleared-up now to reduce confusion.

The remaining 2 files currently left in this patch... "Makefile.am.diff corrected makefile.am.diff" "prezip-bin.1.60 05-09-30, removed unicode references" ...have already been included earlier with Aspell 0.60.x therefore this patch can be safely closed as 'completed"... therefore reducing the number of open patches left.

Thanks.

[Note: #​1821518 = https://sourceforge.net/p/aspell/patches/153/ = #424]

[aspell-helper]

Kevin Atkinson kevina\@sf updated the issue on 2007-10-28 08:54:32 UTC

• status: open --> closed