File 0112-Clarify-what-the-pre-defined-macros-return... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0112-Clarify-what-the-pre-defined-macros-return.patch of Package erlang

From 5a6a50c99b81aeb6d3ec2c227e5b7529af571a36 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= <bjorn@erlang.org>
Date: Tue, 28 May 2024 08:43:13 +0200
Subject: [PATCH] Clarify what the pre-defined macros return

Explicitly mention that ?OTP_RELEASE returns the release running
the compiler.

Closes #8486
---
 system/doc/reference_manual/macros.md | 27 +++++++++++++++++----------
 1 file changed, 17 insertions(+), 10 deletions(-)

diff --git a/system/doc/reference_manual/macros.md b/system/doc/reference_manual/macros.md
index 8678f0e90c..e4d94af063 100644
--- a/system/doc/reference_manual/macros.md
+++ b/system/doc/reference_manual/macros.md
@@ -149,24 +149,31 @@ after preprocessing and parse transforms, in the file `File.P`.
 
 The following macros are predefined:
 
-- **`?MODULE`** - The name of the current module.
+- **`?MODULE`** - The name of the current module, as an atom.
 
-- **`?MODULE_STRING`.** - The name of the current module, as a string.
+- **`?MODULE_STRING`** - The name of the current module, as a string.
 
-- **`?FILE`.** - The file name of the current module.
+- **`?FILE`** - The file name of the current module, as a string.
 
-- **`?LINE`.** - The current line number.
+- **`?LINE`** - The current line number, as an integer.
 
-- **`?MACHINE`.** - The machine name, `'BEAM'`.
+- **`?MACHINE`** - The machine name, `'BEAM'`.
 
-- **`?FUNCTION_NAME`** - The name of the current function.
+- **`?FUNCTION_NAME`** - The name of the current function, as an atom.
 
 - **`?FUNCTION_ARITY`** - The arity (number of arguments) for the current
-  function.
+  function, as an integer.
 
-- **`?OTP_RELEASE`** - The OTP release that the currently executing ERTS
-  application is part of, as an integer. For details, see
-  [`erlang:system_info(otp_release)`](`erlang:system_info/1`).
+- **`?OTP_RELEASE`** - The OTP release for the runtime system that is
+  running the compiler, as an integer. For example, when compiling using
+  Erlang/OTP 27, the macro returns `27`.
+
+  > #### Note {: .info }
+  >
+  > To find out the release at run-time, call
+  > [`erlang:system_info(otp_release)`](`erlang:system_info/1`). Note
+  > that it returns the release as a string. For example, when the
+  > release is Erlang/OTP 27, the string `"27"` will be returned.
 
   > #### Change {: .info }
   >
-- 
2.35.3

Places

File 0112-Clarify-what-the-pre-defined-macros-return.patch of Package erlang

Places