ptp: document struct ptp_clock_request members
authorAhmad Fatoum <a.fatoum@pengutronix.de>
Tue, 17 Nov 2020 21:38:26 +0000 (22:38 +0100)
committerJakub Kicinski <kuba@kernel.org>
Wed, 18 Nov 2020 18:51:17 +0000 (10:51 -0800)
commitd04a53b1c48766665806eb75b73137734abdaa95
treec048412a65dfae0b0e9d4f626ecd6af30e038686
parented30aef3c864f99111e16d4ea5cf29488d99a278
ptp: document struct ptp_clock_request members

It's arguable most people interested in configuring a PPS signal
want it as external output, not as kernel input. PTP_CLK_REQ_PPS
is for input though. Add documentation to nudge readers into
the correct direction.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
Acked-by: Richard Cochran <richardcochran@gmail.com>
Link: https://lore.kernel.org/r/20201117213826.18235-1-a.fatoum@pengutronix.de
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
include/linux/ptp_clock_kernel.h