Skip to content

Commit 8687a6e

Browse files
committed
mathoms.c: consolidate comments
The head of this source file contains quite a few general comment paragraphs. Consolidate them all into one /* * */ block.
1 parent d7244c9 commit 8687a6e

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

mathoms.c

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,29 @@
3232
* but XS code may still explicitly use the long form, i.e.
3333
* Perl_foo(aTHX_ ...)
3434
*
35+
* NOTE: ALL FUNCTIONS IN THIS FILE should have an entry with the 'b' flag in
36+
* embed.fnc.
37+
*
38+
* To move a function to this file, simply cut and paste it here, and change
39+
* its embed.fnc entry to additionally have the 'b' flag. If, for some reason
40+
* a function you'd like to be treated as mathoms can't be moved from its
41+
* current place, simply enclose it between
42+
*
43+
* #ifndef NO_MATHOMS
44+
* ...
45+
* #endif
46+
*
47+
* and add the 'b' flag in embed.fnc.
48+
*
3549
* REMEMBER to update makedef.pl when adding a function to mathoms.c whose
3650
* name doesn't begin with "Perl_".
3751
*
38-
* SMP - Oct. 24, 2005
39-
*
4052
* The compilation of this file can be suppressed; see INSTALL
4153
*
54+
* Some blurb for perlapi.pod:
55+
4256
=head1 Obsolete backwards compatibility functions
57+
4358
Some of these are also deprecated. You can exclude these from
4459
your compiled Perl by adding this option to Configure:
4560
C<-Accflags='-DNO_MATHOMS'>
@@ -59,22 +74,6 @@ C<-Accflags='-DNO_MATHOMS'>
5974
*/
6075
#else
6176

62-
/* NOTE ALL FUNCTIONS IN THIS FILE should have an entry with the 'b' flag in
63-
* embed.fnc.
64-
*
65-
* To move a function to this file, simply cut and paste it here, and change
66-
* its embed.fnc entry to additionally have the 'b' flag. If, for some reason
67-
* a function you'd like to be treated as mathoms can't be moved from its
68-
* current place, simply enclose it between
69-
*
70-
* #ifndef NO_MATHOMS
71-
* ...
72-
* #endif
73-
*
74-
* and add the 'b' flag in embed.fnc.
75-
*
76-
* */
77-
7877
/* ref() is now a macro using Perl_doref;
7978
* this version provided for binary compatibility only.
8079
*/

0 commit comments

Comments
 (0)