Bug 666: document the changes

diff --git a/CHANGES b/CHANGES
index 7126131fa5f6f5eb8c5e1b01fdf624cc8f8b916a..e5399a7c75254157ec15a7bfe07fbb1668e56817 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -2,6 +2,7 @@
 
 Changelog for HylaFAX 4.2.2
 
+* fix a faxq crash involving job alteration (4 Jul 2005)
 * fix error of a pipe file descriptors not being closed (15 Jun 2005)
 * fix error in not employing Class1SwitchingCmd before sending
   prologue frames (15 Jun 2005)

diff --git a/man/faxalter.1 b/man/faxalter.1
index 8e4be4d3d23e42783fffc82537f7967ee9467197..ca36e37fc747f234ce84cb358267619079697b75 100644 (file)
--- a/man/faxalter.1
+++ b/man/faxalter.1
@@ -119,8 +119,8 @@ causes the jobs to be scheduled for any available modem.
 .B \-p
 The jobs should be
 .IR pushed ;
-that is, they should be sent immediately
-(this is equivalent to ``\-a now''.)
+that is, they should be requeued with a time-to-send as the
+current time (this is equivalent to ``\-a now'').
 .TP 10
 .BI \-P " pri"
 Set the scheduling priority for the specified jobs.
@@ -203,7 +203,7 @@ Control protocol tracing.
 (Equivalent to the
 .B \-v
 option.)
-.SH BUGS
+.SH NOTES
 Setting a job's killtime without also setting the time to send
 may cause the wrong value for the killtime to be sent.
 This is because the killtime is calculated as the difference in
@@ -223,6 +223,12 @@ If
 is interrupted during this time then jobs may be left suspended.
 .PP
 .I faxalter
+requeues the job.  This means that the job will end up at the bottom
+of the queue for the job's priority.  Thus, when queues are heavy
+an adjustment of the job's killtime may need to be considered when
+altering any other parameter.
+.PP
+.I faxalter
 only understands how to alter a subset of the available job
 parameters; there are many more client-controllable parameters
 that can only be modified by communicating directly with the server

diff --git a/man/hylafax-server.4f b/man/hylafax-server.4f
index 69da8ff673c35c48270147eaebbd055d0d6d400e..50e1270a6e6cabc59b103ecb5ac3558f423d8dc9 100644 (file)
--- a/man/hylafax-server.4f
+++ b/man/hylafax-server.4f
@@ -595,7 +595,9 @@ are not actively being processed (e.g. a
 program is running to process the job).
 Jobs that are suspended are not processed by the scheduler; and their
 internal state may be safely altered by the owner or a system
-administrator.
+administrator.  Suspending and then releasing a job has the effect
+of requeueing the job, meaning that it will end up at the bottom of
+queue for that job's priority.
 Jobs that are ready for processing by the scheduler are ``submitted''
 and their state is changed to be either 
 .I pending