~/.local/share/sinntp/ documentation

[jwilk]

Issue reported by randomcoder1 at Google Code:

Hi, can you please add more documentation on what the integers in files in ~/.local/share/sinntp/ mean.
My guess is they are intended for sinntp to know where it left off, but I'm not sure.
Also, my apologies if I missed any part of the current documentation that described is.

[jwilk]

You guessed right; this number is identifier of the last successfully downloaded article.
But this is in an implementation detail, and as such it is subject to change in the future versions.
I'd rather leave the format undocumented, but I don't have strong feelings about it. @l9i, what do you think?

[jwilk]

Comment submitted by randomcoder1 at Google Code:

I'll give a little bit more background on why I'm asking this(I should have in my first message).

Suppose sinntp is killed with kill -9, are there explicit/implicit handlers whether in sinntp itself or outside of it that take care of writing the current state to ~/local/share/sinntp.

And two more related questions:
Is SIGKILL the right signal for terminating a sinntp process ?
If SIGKILL is not the right signal, what signal should be used to allow sinntp to gracefully exit ?

Thanks

[jwilk]

SIGKILL is almost never the right signal. It should be used only as last resort.

SIGTERM is the generic signal for program termination. Unfortunately, sinntp doesn't currently handle it gracefully. This is something that we ought to fix.

As a temporary work-around you can use SIGINT, which is handled correctly AFAICT.

[jwilk]

I've opened issue #15 to track SIGTERM handling.