Linux-man Archive on lore.kernel.org
 help / color / Atom feed
From: Eric Rannaud <eric.rannaud@gmail.com>
To: Eric Rannaud <e@nanocritical.com>
Cc: linux-man <linux-man@vger.kernel.org>,
	"Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>,
	Linux API <linux-api@vger.kernel.org>
Subject: Re: [PATCH 1/1] clock_getres.2: dynamic POSIX clock devices can return other errors
Date: Thu, 2 Apr 2020 13:06:59 -0700
Message-ID: <CA+zRj8XYLpa_gep+VxUfQuqeKu+=thMit-jNv1soC8Mh5H43Ug@mail.gmail.com> (raw)
In-Reply-To: <ce049b034919c4a09629c2e7bec574af133fb064.1585837173.git.e@nanocritical.com>

Micheal,

I'm conscious that saying "dynamic POSIX clock device" without any
explanation may be too obscure for a man page.

There is documentation in:
- include/linux/posix-clock.h
- Documentation/driver-api/ptp.rst (explicitly states that EOPNOTSUPP
should be returned)
- include/uapi/linux/ptp_clock.h

(IEEE 1588 PTP is the canonical user of these dynamic clock devices)

Would you want to refer to any of these from the man page?

Thanks for maintaining this project!
Eric

On Thu, Apr 2, 2020 at 7:24 AM Eric Rannaud <e@nanocritical.com> wrote:
>
> See Linux source as of v5.4:
>   kernel/time/posix-clock.c
>
> Signed-off-by: Eric Rannaud <e@nanocritical.com>
> ---
>  man2/clock_getres.2 | 9 +++++++++
>  1 file changed, 9 insertions(+)
>
> diff --git a/man2/clock_getres.2 b/man2/clock_getres.2
> index 0154f9d32473..71f7f8dfa662 100644
> --- a/man2/clock_getres.2
> +++ b/man2/clock_getres.2
> @@ -260,6 +260,10 @@ specified in a call to
>  .BR clock_settime ()
>  is not a settable clock.
>  .TP
> +.B EOPNOTSUPP
> +The operation is not supported by the dynamic POSIX clock device
> +specified.
> +.TP
>  .BR EINVAL " (since Linux 4.3)"
>  .\" commit e1d7ba8735551ed79c7a0463a042353574b96da3
>  A call to
> @@ -276,6 +280,11 @@ clock.
>  .B EPERM
>  .BR clock_settime ()
>  does not have permission to set the clock indicated.
> +.TP
> +.B EACCES
> +.BR clock_settime ()
> +does not have write permission for the dynamic POSIX
> +clock device indicated.
>  .SH VERSIONS
>  These system calls first appeared in Linux 2.6.
>  .SH ATTRIBUTES
> --
> 2.26.0
>

  parent reply index

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-20 18:02 clock_settime(2) error for non-settable clocks Eric Rannaud
2020-03-21  3:56 ` Aleksa Sarai
2020-03-26  8:37 ` Michael Kerrisk (man-pages)
2020-03-29 20:49   ` Michael Kerrisk (man-pages)
2020-04-02 11:48     ` Michael Kerrisk (man-pages)
2020-04-02 14:23       ` [PATCH 1/1] clock_getres.2: dynamic POSIX clock devices can return other errors Eric Rannaud
2020-04-02 19:55         ` Michael Kerrisk (man-pages)
2020-04-02 20:06         ` Eric Rannaud [this message]
2020-04-02 20:19           ` Michael Kerrisk (man-pages)
2020-04-02 20:49             ` Eric Rannaud
2020-04-02 20:50               ` Eric Rannaud
2020-04-03  7:02               ` Michael Kerrisk (man-pages)
2020-04-03 16:42                 ` Eric Rannaud
2020-04-20 11:13               ` Michael Kerrisk (man-pages)
2020-04-02 14:29       ` clock_settime(2) error for non-settable clocks Eric Rannaud

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CA+zRj8XYLpa_gep+VxUfQuqeKu+=thMit-jNv1soC8Mh5H43Ug@mail.gmail.com' \
    --to=eric.rannaud@gmail.com \
    --cc=e@nanocritical.com \
    --cc=linux-api@vger.kernel.org \
    --cc=linux-man@vger.kernel.org \
    --cc=mtk.manpages@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Linux-man Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-man/0 linux-man/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-man linux-man/ https://lore.kernel.org/linux-man \
		linux-man@vger.kernel.org
	public-inbox-index linux-man

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-man


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git