aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias EngdegÄrd2022-08-18 12:08:24 +0200
committerMattias EngdegÄrd2022-08-18 17:10:46 +0200
commitf33a429a53ea2647199804f12e16c65768d526d5 (patch)
tree14bb7d259c719135775d6b4d3aa692e0789545a2
parente75822fba6ee5f1cced6b87305fc0f444803feb7 (diff)
downloademacs-f33a429a53ea2647199804f12e16c65768d526d5.tar.gz
emacs-f33a429a53ea2647199804f12e16c65768d526d5.zip
Copy-edit doc strings and comments wrt bignum and fixnum
Don't say that a value is a fixnum if small enough and a bignum otherwise, because that is now how Lisp integers always work, and we generally don't expose the fixnum/bignum difference to the user unless really necessary. * src/charset.c (Fencode_char): * src/editfns.c (Fuser_uid, Fuser_real_uid, Fgroup_gid) (Fgroup_real_gid, Femacs_pid): * src/font.c (Ffont_variation_glyphs): * src/process.c (Fprocess_id): Edit doc strings. * src/pgtkselect.c: * src/xselect.c: Edit comments.
-rw-r--r--src/charset.c5
-rw-r--r--src/editfns.c15
-rw-r--r--src/font.c6
-rw-r--r--src/pgtkselect.c3
-rw-r--r--src/process.c4
-rw-r--r--src/xselect.c3
6 files changed, 13 insertions, 23 deletions
diff --git a/src/charset.c b/src/charset.c
index 9edbd4c8c84..bb59262fe98 100644
--- a/src/charset.c
+++ b/src/charset.c
@@ -1852,9 +1852,8 @@ although this usage is obsolescent. */)
1852 1852
1853DEFUN ("encode-char", Fencode_char, Sencode_char, 2, 2, 0, 1853DEFUN ("encode-char", Fencode_char, Sencode_char, 2, 2, 0,
1854 doc: /* Encode the character CH into a code-point of CHARSET. 1854 doc: /* Encode the character CH into a code-point of CHARSET.
1855Return the encoded code-point, a fixnum if its value is small enough, 1855Return the encoded code-point as an integer,
1856otherwise a bignum. 1856or nil if CHARSET doesn't support CH. */)
1857Return nil if CHARSET doesn't support CH. */)
1858 (Lisp_Object ch, Lisp_Object charset) 1857 (Lisp_Object ch, Lisp_Object charset)
1859{ 1858{
1860 int c, id; 1859 int c, id;
diff --git a/src/editfns.c b/src/editfns.c
index 07f5c0bbef7..4fb82485abe 100644
--- a/src/editfns.c
+++ b/src/editfns.c
@@ -1172,8 +1172,7 @@ This ignores the environment variables LOGNAME and USER, so it differs from
1172} 1172}
1173 1173
1174DEFUN ("user-uid", Fuser_uid, Suser_uid, 0, 0, 0, 1174DEFUN ("user-uid", Fuser_uid, Suser_uid, 0, 0, 0,
1175 doc: /* Return the effective uid of Emacs. 1175 doc: /* Return the effective uid of Emacs, as an integer. */)
1176Value is a fixnum, if it's small enough, otherwise a bignum. */)
1177 (void) 1176 (void)
1178{ 1177{
1179 uid_t euid = geteuid (); 1178 uid_t euid = geteuid ();
@@ -1181,8 +1180,7 @@ Value is a fixnum, if it's small enough, otherwise a bignum. */)
1181} 1180}
1182 1181
1183DEFUN ("user-real-uid", Fuser_real_uid, Suser_real_uid, 0, 0, 0, 1182DEFUN ("user-real-uid", Fuser_real_uid, Suser_real_uid, 0, 0, 0,
1184 doc: /* Return the real uid of Emacs. 1183 doc: /* Return the real uid of Emacs, as an integer. */)
1185Value is a fixnum, if it's small enough, otherwise a bignum. */)
1186 (void) 1184 (void)
1187{ 1185{
1188 uid_t uid = getuid (); 1186 uid_t uid = getuid ();
@@ -1208,8 +1206,7 @@ Return nil if a group with such GID does not exists or is not known. */)
1208} 1206}
1209 1207
1210DEFUN ("group-gid", Fgroup_gid, Sgroup_gid, 0, 0, 0, 1208DEFUN ("group-gid", Fgroup_gid, Sgroup_gid, 0, 0, 0,
1211 doc: /* Return the effective gid of Emacs. 1209 doc: /* Return the effective gid of Emacs, as an integer. */)
1212Value is a fixnum, if it's small enough, otherwise a bignum. */)
1213 (void) 1210 (void)
1214{ 1211{
1215 gid_t egid = getegid (); 1212 gid_t egid = getegid ();
@@ -1217,8 +1214,7 @@ Value is a fixnum, if it's small enough, otherwise a bignum. */)
1217} 1214}
1218 1215
1219DEFUN ("group-real-gid", Fgroup_real_gid, Sgroup_real_gid, 0, 0, 0, 1216DEFUN ("group-real-gid", Fgroup_real_gid, Sgroup_real_gid, 0, 0, 0,
1220 doc: /* Return the real gid of Emacs. 1217 doc: /* Return the real gid of Emacs, as an integer. */)
1221Value is a fixnum, if it's small enough, otherwise a bignum. */)
1222 (void) 1218 (void)
1223{ 1219{
1224 gid_t gid = getgid (); 1220 gid_t gid = getgid ();
@@ -1306,8 +1302,7 @@ DEFUN ("system-name", Fsystem_name, Ssystem_name, 0, 0, 0,
1306} 1302}
1307 1303
1308DEFUN ("emacs-pid", Femacs_pid, Semacs_pid, 0, 0, 0, 1304DEFUN ("emacs-pid", Femacs_pid, Semacs_pid, 0, 0, 0,
1309 doc: /* Return the process ID of Emacs, as a number. 1305 doc: /* Return the process ID of Emacs, as an integer. */)
1310Value is a fixnum, if it's small enough, otherwise a bignum. */)
1311 (void) 1306 (void)
1312{ 1307{
1313 pid_t pid = getpid (); 1308 pid_t pid = getpid ();
diff --git a/src/font.c b/src/font.c
index 3846cfc1079..8acedb9bf88 100644
--- a/src/font.c
+++ b/src/font.c
@@ -4691,8 +4691,7 @@ Each element of the value is a cons (VARIATION-SELECTOR . GLYPH-ID),
4691where 4691where
4692 VARIATION-SELECTOR is a character code of variation selector 4692 VARIATION-SELECTOR is a character code of variation selector
4693 (#xFE00..#xFE0F or #xE0100..#xE01EF). 4693 (#xFE00..#xFE0F or #xE0100..#xE01EF).
4694 GLYPH-ID is a glyph code of the corresponding variation glyph, 4694 GLYPH-ID is a glyph code of the corresponding variation glyph, an integer. */)
4695a fixnum, if it's small enough, otherwise a bignum. */)
4696 (Lisp_Object font_object, Lisp_Object character) 4695 (Lisp_Object font_object, Lisp_Object character)
4697{ 4696{
4698 unsigned variations[256]; 4697 unsigned variations[256];
@@ -4729,8 +4728,7 @@ a fixnum, if it's small enough, otherwise a bignum. */)
4729 that apply to POSITION. POSITION may be nil, in which case, 4728 that apply to POSITION. POSITION may be nil, in which case,
4730 FONT-SPEC is the font for displaying the character CH with the 4729 FONT-SPEC is the font for displaying the character CH with the
4731 default face. GLYPH-CODE is the glyph code in the font to use for 4730 default face. GLYPH-CODE is the glyph code in the font to use for
4732 the character, it is a fixnum, if it is small enough, otherwise a 4731 the character, as an integer.
4733 bignum.
4734 4732
4735 For a text terminal, return a nonnegative integer glyph code for 4733 For a text terminal, return a nonnegative integer glyph code for
4736 the character, or a negative integer if the character is not 4734 the character, or a negative integer if the character is not
diff --git a/src/pgtkselect.c b/src/pgtkselect.c
index e0230003b3a..212bbd56aa4 100644
--- a/src/pgtkselect.c
+++ b/src/pgtkselect.c
@@ -1248,8 +1248,7 @@ pgtk_get_window_property_as_lisp_data (struct pgtk_display_info *dpyinfo,
1248 ATOM 32 > 1 Vector of Symbols 1248 ATOM 32 > 1 Vector of Symbols
1249 * 16 1 Integer 1249 * 16 1 Integer
1250 * 16 > 1 Vector of Integers 1250 * 16 > 1 Vector of Integers
1251 * 32 1 if small enough: fixnum 1251 * 32 1 Integer
1252 otherwise: bignum
1253 * 32 > 1 Vector of the above 1252 * 32 > 1 Vector of the above
1254 1253
1255 When converting an object to C, it may be of the form (SYMBOL 1254 When converting an object to C, it may be of the form (SYMBOL
diff --git a/src/process.c b/src/process.c
index 23479c06194..697249a461b 100644
--- a/src/process.c
+++ b/src/process.c
@@ -1209,8 +1209,8 @@ If PROCESS has not yet exited or died, return 0. */)
1209 1209
1210DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0, 1210DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
1211 doc: /* Return the process id of PROCESS. 1211 doc: /* Return the process id of PROCESS.
1212This is the pid of the external process which PROCESS uses or talks to. 1212This is the pid of the external process which PROCESS uses or talks to,
1213It is a fixnum if the value is small enough, otherwise a bignum. 1213an integer.
1214For a network, serial, and pipe connections, this value is nil. */) 1214For a network, serial, and pipe connections, this value is nil. */)
1215 (register Lisp_Object process) 1215 (register Lisp_Object process)
1216{ 1216{
diff --git a/src/xselect.c b/src/xselect.c
index d6e6d0c30b8..bab0400540e 100644
--- a/src/xselect.c
+++ b/src/xselect.c
@@ -1754,8 +1754,7 @@ x_get_window_property_as_lisp_data (struct x_display_info *dpyinfo,
1754 ATOM 32 > 1 Vector of Symbols 1754 ATOM 32 > 1 Vector of Symbols
1755 * 16 1 Integer 1755 * 16 1 Integer
1756 * 16 > 1 Vector of Integers 1756 * 16 > 1 Vector of Integers
1757 * 32 1 if small enough: fixnum 1757 * 32 1 Integer
1758 otherwise: bignum
1759 * 32 > 1 Vector of the above 1758 * 32 > 1 Vector of the above
1760 1759
1761 When converting an object to C, it may be of the form (SYMBOL . <data>) 1760 When converting an object to C, it may be of the form (SYMBOL . <data>)