time: Improve documentation of timekeeeping_adjust()
authorJohn Stultz <john.stultz@linaro.org>
Fri, 28 Oct 2011 01:12:42 +0000 (18:12 -0700)
committerIngo Molnar <mingo@elte.hu>
Fri, 28 Oct 2011 06:57:38 +0000 (08:57 +0200)
commitc2bc11113c50449f23c40b724fe410fc2380a8e9
treef5a6a5f9c199d6b3ed7a973dfb7556ad2af2bf5a
parente35f95b36e43f67a6f806172555a152c11ea0a78
time: Improve documentation of timekeeeping_adjust()

After getting a number of questions in private emails about the
math around admittedly very complex timekeeping_adjust() and
timekeeping_big_adjust(), I figure the code needs some better
comments.

Hopefully the explanations are clear enough and don't muddy the
water any worse.

Still needs documentation for ntp_error, but I couldn't recall
exactly the full explanation behind the code that's there
(although I do recall once working it out when Roman first
proposed it). Given a bit more time I can probably work it out,
but I don't want to hold back this documentation until then.

Signed-off-by: John Stultz <john.stultz@linaro.org>
Cc: Chen Jie <chenj@lemote.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Link: http://lkml.kernel.org/r/1319764362-32367-1-git-send-email-john.stultz@linaro.org
Signed-off-by: Ingo Molnar <mingo@elte.hu>
kernel/time/timekeeping.c