seomoz / qless

Queue / Pipeline Management
MIT License
294 stars 76 forks source link

Incorrect documentation about signal handlers #260

Open brianchhun opened 7 years ago

brianchhun commented 7 years ago

There are a couple pieces of documentation that describe how a worker will respond to a given signal, but these look like they need to be updated since the signal handling was refactored some time ago.

For example, in the README, it says "the child process supports the USR2 signal, whch causes it to dump its current backtrace."but it looks like USR2 will actually pause the process.

Also, deeper in the code, where the signal handlers are installed, is another set of descriptions for each signal (https://github.com/seomoz/qless/blob/master/lib/qless/worker/base.rb#L68). HUP is said to "Print current stack to log and continue", but I can't find the code that does such a thing, and the default, which is set in the initializer, appears to be a no-op (https://github.com/seomoz/qless/blob/master/lib/qless/worker/base.rb#L25).

Is it possible to fix the comments or remove them outright to avoid further confusion?