summaryrefslogtreecommitdiff
path: root/mathoms.c
diff options
context:
space:
mode:
authorDavid Mitchell <davem@iabyn.com>2016-05-23 15:53:05 +0100
committerDavid Mitchell <davem@iabyn.com>2016-05-23 16:01:05 +0100
commit8687a6e6de7ce658ece8673ad56c37d0a1d8cbca (patch)
treeadf434d29ab0523d281a8cdb465d5df51fdb7a3e /mathoms.c
parentd7244c9a613101b97077ed781e11a729c347555c (diff)
downloadperl-8687a6e6de7ce658ece8673ad56c37d0a1d8cbca.tar.gz
mathoms.c: consolidate comments
The head of this source file contains quite a few general comment paragraphs. Consolidate them all into one /* * */ block.
Diffstat (limited to 'mathoms.c')
-rw-r--r--mathoms.c35
1 files changed, 17 insertions, 18 deletions
diff --git a/mathoms.c b/mathoms.c
index 0ebf4349f7..3604d41a40 100644
--- a/mathoms.c
+++ b/mathoms.c
@@ -32,14 +32,29 @@
* but XS code may still explicitly use the long form, i.e.
* Perl_foo(aTHX_ ...)
*
+ * NOTE: ALL FUNCTIONS IN THIS FILE should have an entry with the 'b' flag in
+ * embed.fnc.
+ *
+ * To move a function to this file, simply cut and paste it here, and change
+ * its embed.fnc entry to additionally have the 'b' flag. If, for some reason
+ * a function you'd like to be treated as mathoms can't be moved from its
+ * current place, simply enclose it between
+ *
+ * #ifndef NO_MATHOMS
+ * ...
+ * #endif
+ *
+ * and add the 'b' flag in embed.fnc.
+ *
* REMEMBER to update makedef.pl when adding a function to mathoms.c whose
* name doesn't begin with "Perl_".
*
- * SMP - Oct. 24, 2005
- *
* The compilation of this file can be suppressed; see INSTALL
*
+ * Some blurb for perlapi.pod:
+
=head1 Obsolete backwards compatibility functions
+
Some of these are also deprecated. You can exclude these from
your compiled Perl by adding this option to Configure:
C<-Accflags='-DNO_MATHOMS'>
@@ -59,22 +74,6 @@ C<-Accflags='-DNO_MATHOMS'>
*/
#else
-/* NOTE ALL FUNCTIONS IN THIS FILE should have an entry with the 'b' flag in
- * embed.fnc.
- *
- * To move a function to this file, simply cut and paste it here, and change
- * its embed.fnc entry to additionally have the 'b' flag. If, for some reason
- * a function you'd like to be treated as mathoms can't be moved from its
- * current place, simply enclose it between
- *
- * #ifndef NO_MATHOMS
- * ...
- * #endif
- *
- * and add the 'b' flag in embed.fnc.
- *
- * */
-
/* ref() is now a macro using Perl_doref;
* this version provided for binary compatibility only.
*/