From: Eli Zaretskii <eliz@gnu.org>
To: Philipp Stephani <p.stephani2@gmail.com>
Cc: phst@google.com, eggert@cs.ucla.edu, emacs-devel@gnu.org
Subject: Re: [PATCH 1/2] Add conversions to and from struct timespec to module interface.
Date: Wed, 24 Apr 2019 10:21:52 +0300 [thread overview]
Message-ID: <83o94v3m27.fsf@gnu.org> (raw)
In-Reply-To: <20190423213218.35618-1-phst@google.com> (message from Philipp Stephani on Tue, 23 Apr 2019 23:32:17 +0200)
> From: Philipp Stephani <p.stephani2@gmail.com>
> Cc: Philipp Stephani <phst@google.com>
> Date: Tue, 23 Apr 2019 23:32:17 +0200
>
> +@deftypefn Function struct timespec extract_time (emacs_env *@var{env}, emacs_value @var{time})
> +This function, which is available since Emacs 27, interprets
> +@var{time} as an Emacs time value and returns the corresponding
> +@code{struct timespec}. @xref{Time of Day}.
I think we need to tell something about 'struct timespec' here.
Ideally, simply describe its members, unless they are too platform
dependent. This text is for C programmers, who will need to look up
the struct to be able to use this function.
> This function signals an
> +error if @var{time} is out of range for @code{struct timespec}.
Instead of "out of range for", I'd prefer saying "cannot be
represented by", perhaps with an example. "Out of range" is a
complicated subject when talking about time values, and we shouldn't
assume the reader is an expert on time handling.
> If
> +@var{time} has higher precision than nanoseconds, then this function
> +truncates it to nanosecond precision.
If we describe 'struct timespec', this sentence will be redundant, I
think. (Btw, "truncates" or "rounds", and if the former, why not the
latter?)
> +This function, which is available since Emacs 27, takes a @code{struct
> +timespec} argument @var{time} and returns the corresponding Emacs
> +timestamp. @xref{Time of Day} for the possible return value formats.
^
There should be a comma there, or makeinfo will produce a warning.
> +It is not specified in which timestamp format the time is returned,
> +but it is always a valid Emacs timestamp.
I question the wisdom of such an obscurity. There are no secrets
here, as the source code is available, and I can envision use cases
where the programmer does really need to know the structure of the
returned timestamp. Why should we make this "unspecified"?
> The return value is exactly
> +the same timestamp as @var{time}: all input values are representable,
> +and there is never a loss of precision. @code{time.tv_sec} and
> +@code{time.tv_nsec} can be arbitrary values.
Here you reference members of 'struct timespec' without describing the
struct first, which I think is confusing. One more reason to describe
the struct explcitly
> +@code{time.tv_nsec} doesn't have to be in the range [0, 999999999].
^^^^^^^^^^^^^^
This should be in @code, and I think using @dots{} instead of the
comma will look better in print.
> +** New module environment functions 'make_time' and 'extract_time' to
> +convert between timespec structures and Emacs time values.
^^^^^^^^^^^^^^^^^
"Emacs Lisp time values", I'd say.
Thanks.
next prev parent reply other threads:[~2019-04-24 7:21 UTC|newest]
Thread overview: 87+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-23 13:17 [PATCH 1/2] Add conversions to and from struct timespec to module interface Philipp Stephani
2019-04-23 13:17 ` [PATCH 2/2] Add module functions to convert from and to big integers Philipp Stephani
2019-04-23 14:30 ` Eli Zaretskii
2019-04-23 14:51 ` Paul Eggert
2019-04-23 15:12 ` Philipp Stephani
2019-04-23 15:48 ` Paul Eggert
2019-04-23 15:54 ` Philipp Stephani
2019-11-02 19:17 ` Philipp Stephani
2019-11-03 19:38 ` Stefan Monnier
2019-11-13 18:46 ` Philipp Stephani
2019-11-17 18:38 ` [PATCH] Change module interface to no longer use GMP objects directly Philipp Stephani
2019-11-18 21:21 ` Paul Eggert
2019-11-19 21:12 ` Philipp Stephani
2019-11-19 21:54 ` Paul Eggert
2019-11-20 21:06 ` Philipp Stephani
2019-11-20 21:24 ` Paul Eggert
2019-11-20 21:30 ` Philipp Stephani
2019-11-21 1:12 ` Paul Eggert
2019-11-21 20:31 ` Philipp Stephani
2019-11-23 2:13 ` Paul Eggert
2019-11-23 20:08 ` Philipp Stephani
2019-11-23 23:10 ` Paul Eggert
2019-11-23 20:46 ` Stefan Monnier
2019-11-23 23:10 ` Paul Eggert
2019-11-24 9:28 ` Andreas Schwab
2019-11-25 21:03 ` Paul Eggert
2019-11-25 21:59 ` Philipp Stephani
2019-12-04 20:31 ` Philipp Stephani
2019-12-05 14:43 ` Eli Zaretskii
2019-12-08 20:28 ` Philipp Stephani
2019-12-09 3:26 ` Eli Zaretskii
2019-12-09 4:58 ` Paul Eggert
2019-12-09 13:22 ` Eli Zaretskii
2019-12-09 23:15 ` Philipp Stephani
2019-12-10 0:22 ` Paul Eggert
2019-12-10 13:15 ` Philipp Stephani
2019-12-10 15:57 ` Eli Zaretskii
2019-12-14 16:06 ` Philipp Stephani
2019-12-14 19:54 ` Paul Eggert
2019-12-09 0:35 ` Paul Eggert
2019-12-09 13:19 ` Eli Zaretskii
2019-04-23 15:16 ` [PATCH 1/2] Add conversions to and from struct timespec to module interface Paul Eggert
2019-04-23 21:32 ` Philipp Stephani
[not found] ` <20190423213218.35618-2-phst@google.com>
2019-04-23 21:43 ` [PATCH 2/2] Add module functions to convert from and to big integers Paul Eggert
2019-04-24 16:03 ` Eli Zaretskii
2019-04-24 16:37 ` Philipp Stephani
2019-04-24 16:51 ` Eli Zaretskii
2019-04-24 16:57 ` Philipp Stephani
2019-04-24 17:11 ` Eli Zaretskii
2019-04-24 17:15 ` Philipp Stephani
2019-04-24 17:23 ` Eli Zaretskii
2019-04-24 17:28 ` Philipp Stephani
2019-04-24 17:51 ` [PATCH] Unbreak build when building without GMP support Philipp Stephani
2019-04-24 18:41 ` Eli Zaretskii
2019-04-24 18:49 ` Philipp Stephani
2019-04-24 19:06 ` Eli Zaretskii
2019-04-24 19:19 ` Philipp Stephani
2019-04-24 19:30 ` Eli Zaretskii
2019-04-24 21:15 ` Philipp Stephani
2019-04-25 6:04 ` Eli Zaretskii
2019-04-25 6:39 ` Eli Zaretskii
2019-04-25 10:24 ` Philipp Stephani
2019-04-24 21:34 ` Philipp Stephani
2019-04-24 19:44 ` [PATCH 2/2] Add module functions to convert from and to big integers Stefan Monnier
2019-04-24 20:15 ` Paul Eggert
2019-04-24 20:57 ` Stefan Monnier
2019-04-24 21:17 ` Philipp Stephani
2019-04-24 23:32 ` Paul Eggert
2019-04-24 21:19 ` Philipp Stephani
2019-04-25 0:00 ` Paul Eggert
2019-04-25 5:33 ` Eli Zaretskii
2019-04-25 10:41 ` Philipp Stephani
2019-04-25 13:46 ` [PATCH 1/2] Require full GMP when building module support Philipp Stephani
2019-04-25 13:46 ` [PATCH 2/2] Check for __attribute__ ((cleanup)) during configuration Philipp Stephani
2019-04-25 21:18 ` Paul Eggert
2019-04-28 18:12 ` Philipp Stephani
2019-04-25 14:37 ` [PATCH 1/2] Require full GMP when building module support Eli Zaretskii
2019-04-25 15:06 ` Philipp Stephani
2019-04-25 16:14 ` Eli Zaretskii
2019-04-25 17:09 ` [PATCH] Require full GMP for big integer module functions Philipp Stephani
2019-04-25 21:00 ` Paul Eggert
2019-04-28 18:14 ` Philipp Stephani
2019-04-28 20:18 ` Paul Eggert
2019-04-28 17:10 ` [PATCH 1/2] Require full GMP when building module support Philipp Stephani
2019-04-24 7:21 ` Eli Zaretskii [this message]
2019-04-24 11:03 ` [PATCH 1/2] Add conversions to and from struct timespec to module interface Philipp Stephani
2019-04-24 11:44 ` Eli Zaretskii
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=83o94v3m27.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=eggert@cs.ucla.edu \
--cc=emacs-devel@gnu.org \
--cc=p.stephani2@gmail.com \
--cc=phst@google.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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.