From: Eli Zaretskii <eliz@gnu.org>
To: Alan Mackenzie <acm@muc.de>
Cc: stefankangas@gmail.com, emacs-devel@gnu.org, mattiase@acm.org
Subject: Re: Why shouldn't we have a #if .... #else .... #endif construct in Emacs Lisp?
Date: Sat, 02 Sep 2023 18:17:51 +0300 [thread overview]
Message-ID: <834jkca9k0.fsf@gnu.org> (raw)
In-Reply-To: <ZPNPhh_My1P6k0vw@ACM> (message from Alan Mackenzie on Sat, 2 Sep 2023 15:06:46 +0000)
> Date: Sat, 2 Sep 2023 15:06:46 +0000
> Cc: emacs-devel@gnu.org,
> Mattias Engdegård <mattiase@acm.org>
> From: Alan Mackenzie <acm@muc.de>
>
> +@node Conditional Compilation
> +@section Conditional Compilation
> +
> + There will be times when you want certain code to be compiled only
> +when a certain condition holds. This is particularly the case when
> +maintaining Emacs packages; to keep the package compatible with older
> +versions of Emacs you may need to use a function or variable which has
> +become obsolete in the current version of Emacs.
> +
> + You could just use a conditional form to select the old or new form
> +at run time, but this tends to output annoying warning messages about
> +the obsolete function/variable. For such situations, the macro
> +@code{static-if} comes in handy. It is inspired by the conditional
> +compilation directives like @code{#if} in C like languages, and is
> +patterned after the special form @code{if} (@pxref{Conditionals}).
> +
> + To use this facility for an older version of Emacs, copy the source
> +for @code{static-if} from the Emacs source file @file{lisp/subr.el}
> +into your package.
Thanks, but I think the references to #if make the documentation less
helpful than it could be. This manual is for Lisp programmers, and
those are not necessarily familiar with C and its preprocessor
directives. So I think it would be better if you removed the
references to cpp. If you think removing that would make the
documentation less self-explanatory, I suggest to add explanations
that are based on Lisp and on typical situations while writing Lisp
programs, not on cpp.
> --- a/etc/NEWS
> +++ b/etc/NEWS
> @@ -855,6 +855,10 @@ Use 'define-minor-mode' and 'define-globalized-minor-mode' instead.
> See the "(elisp) Porting Old Advice" node for help converting them
> to use 'advice-add' or 'define-advice' instead.
>
> ++++
> +** There is now conditional compilation, based on the C language's #if.
> +To use this, see the new macro 'static-if'.
Same here. Here, it is actually worse: "based on C language's #if"
could be misinterpreted as meaning the implementation is based on #if
in some way. I would suggest the following text in NEWS:
** New macro 'static-if' for conditional byte-compilation of code.
This macro hides a form from the byte-compiler based on a
compile-time condition. This is handy for avoiding byte-compilation
warnings about code that will never actually run under some
conditions.
Thanks.
next prev parent reply other threads:[~2023-09-02 15:17 UTC|newest]
Thread overview: 66+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-08-28 19:37 Why shouldn't we have a #if .... #else .... #endif construct in Emacs Lisp? Alan Mackenzie
2023-08-28 19:47 ` Ulrich Mueller
2023-08-28 20:06 ` Alan Mackenzie
2023-08-28 21:01 ` Ulrich Mueller
2023-08-28 21:46 ` Alan Mackenzie
2023-08-31 2:07 ` Richard Stallman
2023-08-31 7:50 ` Alan Mackenzie
2023-09-04 1:34 ` Richard Stallman
2023-09-04 10:50 ` Alan Mackenzie
2023-09-04 11:02 ` tomas
2023-09-04 15:19 ` Emanuel Berg
2023-09-04 18:57 ` tomas
2023-09-06 0:58 ` Richard Stallman
2023-09-06 0:58 ` Richard Stallman
2023-09-06 7:28 ` Andreas Schwab
2023-09-06 9:31 ` Alan Mackenzie
2023-09-06 9:56 ` Alan Mackenzie
2023-09-09 0:39 ` Richard Stallman
2023-09-09 10:32 ` Ihor Radchenko
2023-09-10 0:22 ` Richard Stallman
2023-09-10 8:36 ` Ihor Radchenko
2023-09-13 23:53 ` Richard Stallman
2023-09-20 12:59 ` Ihor Radchenko
2023-09-05 0:30 ` Why have a #if .... #else .... #endif construct in Emacs Lisp, when we could make the existing code DTRT unchanged? Richard Stallman
2023-09-05 0:41 ` Emanuel Berg
2023-09-08 17:54 ` Emanuel Berg
2023-09-05 4:37 ` tomas
2023-09-05 5:53 ` Ihor Radchenko
2023-09-05 6:28 ` tomas
2023-09-05 11:06 ` Adam Porter
2023-09-05 11:26 ` Lynn Winebarger
2023-09-05 14:11 ` Alan Mackenzie
2023-09-08 1:01 ` Richard Stallman
2023-09-08 2:45 ` Po Lu
2023-09-10 0:24 ` Richard Stallman
2023-09-05 8:14 ` Why shouldn't we have a #if .... #else .... #endif construct in Emacs Lisp? Ulrich Mueller
2023-08-28 19:53 ` Emanuel Berg
2023-08-29 9:19 ` Alan Mackenzie
2023-08-29 10:36 ` João Távora
2023-08-29 11:09 ` Ihor Radchenko
2023-08-29 11:20 ` João Távora
2023-08-30 20:48 ` Sean Whitton
2023-08-30 20:59 ` João Távora
2023-09-02 23:12 ` Stefan Monnier via Emacs development discussions.
2023-09-03 0:18 ` Emanuel Berg
2023-09-03 12:27 ` João Távora
2023-08-29 12:54 ` Philip Kaludercic
2023-08-29 13:23 ` Alan Mackenzie
2023-09-02 23:09 ` Stefan Monnier via Emacs development discussions.
2023-08-29 16:28 ` LdBeth
2023-08-29 20:09 ` Stefan Kangas
2023-08-30 10:31 ` Alan Mackenzie
2023-08-30 17:36 ` Stefan Kangas
2023-08-30 18:03 ` Alan Mackenzie
2023-08-30 18:17 ` Stefan Kangas
2023-09-02 15:06 ` Alan Mackenzie
2023-09-02 15:17 ` Eli Zaretskii [this message]
2023-09-02 19:43 ` Alan Mackenzie
2023-09-03 4:42 ` Eli Zaretskii
2023-09-03 10:48 ` Alan Mackenzie
2023-09-03 11:02 ` Eli Zaretskii
2023-09-03 13:24 ` Alan Mackenzie
2023-09-02 19:20 ` Philip Kaludercic
2023-09-02 19:37 ` Stefan Kangas
2023-09-02 19:58 ` Alan Mackenzie
2023-09-04 11:12 ` Lynn Winebarger
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=834jkca9k0.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=acm@muc.de \
--cc=emacs-devel@gnu.org \
--cc=mattiase@acm.org \
--cc=stefankangas@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
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.