changeset 21066:258c787cd9ce

maint: Use "FIXME:" consistently in code base. * file-editor-tab.h, mxarray.in.h, pr-output.cc, symtab.h, ov-bool-sparse.h, ov-bool.h, ov-float.h, ov-scalar.h, ov-str-mat.cc, oct-parse.in.yy, f77-fcn.h, lo-specfun.cc, randmtzig.c, randpoisson.c, lo-ieee.h, oct-rl-edit.c, sparse-util.h: Use "FIXME:" consistently in code base.
author Rik <rik@octave.org>
date Thu, 14 Jan 2016 07:02:41 -0800
parents e1ee2203efe0
children 9b3149cd486b
files libgui/src/m-editor/file-editor-tab.h libinterp/corefcn/mxarray.in.h libinterp/corefcn/pr-output.cc libinterp/corefcn/symtab.h libinterp/octave-value/ov-bool-sparse.h libinterp/octave-value/ov-bool.h libinterp/octave-value/ov-float.h libinterp/octave-value/ov-scalar.h libinterp/octave-value/ov-str-mat.cc libinterp/parse-tree/oct-parse.in.yy liboctave/cruft/misc/f77-fcn.h liboctave/numeric/lo-specfun.cc liboctave/numeric/randmtzig.c liboctave/numeric/randpoisson.c liboctave/util/lo-ieee.h liboctave/util/oct-rl-edit.c liboctave/util/sparse-util.h
diffstat 17 files changed, 30 insertions(+), 31 deletions(-) [+]
line wrap: on
line diff
--- a/libgui/src/m-editor/file-editor-tab.h	Thu Jan 14 06:20:28 2016 -0500
+++ b/libgui/src/m-editor/file-editor-tab.h	Thu Jan 14 07:02:41 2016 -0800
@@ -33,7 +33,7 @@
 #include <QLabel>
 #include <QComboBox>
 
-// FIXME -- we should not be including config.h in header files.
+// FIXME: We should not be including config.h in header files.
 // Only needed for octave_value_list type.
 #ifdef HAVE_CONFIG_H
 #include <config.h>
--- a/libinterp/corefcn/mxarray.in.h	Thu Jan 14 06:20:28 2016 -0500
+++ b/libinterp/corefcn/mxarray.in.h	Thu Jan 14 07:02:41 2016 -0800
@@ -82,9 +82,9 @@
 typedef char mxChar;
 
 /*
- * FIXME? Mathworks says these should be size_t on 64-bit system and when
- * mex is used with the -largearraydims flag, but why do that? Its better
- * to conform to the same indexing as the rest of Octave
+ * FIXME: Mathworks says these should be size_t on 64-bit system and when
+ * mex is used with the -largearraydims flag, but why do that?  Its better
+ * to conform to the same indexing as the rest of Octave.
  */
 typedef %OCTAVE_IDX_TYPE% mwSize;
 typedef %OCTAVE_IDX_TYPE% mwIndex;
--- a/libinterp/corefcn/pr-output.cc	Thu Jan 14 06:20:28 2016 -0500
+++ b/libinterp/corefcn/pr-output.cc	Thu Jan 14 07:02:41 2016 -0800
@@ -2808,7 +2808,7 @@
 void
 octave_print_internal (std::ostream& os, const charMatrix& chm,
                        bool pr_as_read_syntax,
-                       int /* extra_indent FIXME */,
+                       int /* FIXME: extra_indent */,
                        bool pr_as_string)
 {
   if (pr_as_string)
--- a/libinterp/corefcn/symtab.h	Thu Jan 14 06:20:28 2016 -0500
+++ b/libinterp/corefcn/symtab.h	Thu Jan 14 07:02:41 2016 -0800
@@ -173,7 +173,7 @@
     static const unsigned int local = 1;
 
     // varargin, argn, .nargin., .nargout.
-    // (FIXME -- is this really used now?)
+    // (FIXME: is this really used now?)
     static const unsigned int automatic = 2;
 
     // formal parameter
--- a/libinterp/octave-value/ov-bool-sparse.h	Thu Jan 14 06:20:28 2016 -0500
+++ b/libinterp/octave-value/ov-bool-sparse.h	Thu Jan 14 07:02:41 2016 -0800
@@ -84,7 +84,7 @@
 
   octave_base_value *try_narrowing_conversion (void);
 
-  // FIXME Adapt idx_vector to allow sparse logical indexing without overflow!!
+  // FIXME: Adapt idx_vector to allow sparse logical indexing without overflow!
   idx_vector index_vector (bool /* require_integers */ = false) const
   {
     return idx_vector (matrix);
--- a/libinterp/octave-value/ov-bool.h	Thu Jan 14 06:20:28 2016 -0500
+++ b/libinterp/octave-value/ov-bool.h	Thu Jan 14 07:02:41 2016 -0800
@@ -182,7 +182,7 @@
   SparseMatrix sparse_matrix_value (bool = false) const
   { return SparseMatrix (Matrix (1, 1, scalar)); }
 
-  // FIXME Need SparseComplexMatrix (Matrix) constructor!!!
+  // FIXME: Need SparseComplexMatrix (Matrix) constructor!
   SparseComplexMatrix sparse_complex_matrix_value (bool = false) const
   { return SparseComplexMatrix (sparse_matrix_value ()); }
 
--- a/libinterp/octave-value/ov-float.h	Thu Jan 14 06:20:28 2016 -0500
+++ b/libinterp/octave-value/ov-float.h	Thu Jan 14 07:02:41 2016 -0800
@@ -164,7 +164,7 @@
   SparseMatrix sparse_matrix_value (bool = false) const
   { return SparseMatrix (Matrix (1, 1, scalar)); }
 
-  // FIXME Need SparseComplexMatrix (Matrix) constructor!!!
+  // FIXME: Need SparseComplexMatrix (Matrix) constructor!
   SparseComplexMatrix sparse_complex_matrix_value (bool = false) const
   { return SparseComplexMatrix (sparse_matrix_value ()); }
 
--- a/libinterp/octave-value/ov-scalar.h	Thu Jan 14 06:20:28 2016 -0500
+++ b/libinterp/octave-value/ov-scalar.h	Thu Jan 14 07:02:41 2016 -0800
@@ -163,7 +163,7 @@
   SparseMatrix sparse_matrix_value (bool = false) const
   { return SparseMatrix (Matrix (1, 1, scalar)); }
 
-  // FIXME Need SparseComplexMatrix (Matrix) constructor!!!
+  // FIXME: Need SparseComplexMatrix (Matrix) constructor!
   SparseComplexMatrix sparse_complex_matrix_value (bool = false) const
   { return SparseComplexMatrix (sparse_matrix_value ()); }
 
--- a/libinterp/octave-value/ov-str-mat.cc	Thu Jan 14 06:20:28 2016 -0500
+++ b/libinterp/octave-value/ov-str-mat.cc	Thu Jan 14 07:02:41 2016 -0800
@@ -241,7 +241,8 @@
 
   charMatrix chm (matrix);
 
-  return chm.row_as_string (0);  // FIXME?
+  // FIXME: Is this correct?
+  return chm.row_as_string (0);
 }
 
 Array<std::string>
--- a/libinterp/parse-tree/oct-parse.in.yy	Thu Jan 14 06:20:28 2016 -0500
+++ b/libinterp/parse-tree/oct-parse.in.yy	Thu Jan 14 07:02:41 2016 -0800
@@ -85,7 +85,7 @@
 extern int octave_lex (YYSTYPE *, void *);
 
 // Global access to currently active lexer.
-// FIXME -- to be removed after more parser+lexer refactoring.
+// FIXME: to be removed after more parser+lexer refactoring.
 octave_base_lexer *LEXER = 0;
 
 #if defined (GNULIB_NAMESPACE)
@@ -2387,7 +2387,7 @@
         if (op == DQ_STRING)
           txt = undo_string_escapes (txt);
 
-        // FIXME -- maybe this should also be handled by
+        // FIXME: maybe this should also be handled by
         // tok_val->text_rep () for character strings?
         retval->stash_original_text (delim + txt + delim);
       }
@@ -2420,7 +2420,7 @@
 octave_base_parser::make_anon_fcn_handle (tree_parameter_list *param_list,
                                           tree_statement *stmt)
 {
-  // FIXME -- need to get these from the location of the @ symbol.
+  // FIXME: need to get these from the location of the @ symbol.
   int l = lexer.input_line_number;
   int c = lexer.current_input_column;
 
@@ -3172,7 +3172,7 @@
   if (! autoloading && lexer.reading_fcn_file
       && curr_fcn_depth == 1 && ! parsing_subfunctions)
   {
-    // FIXME -- should lexer.fcn_file_name already be
+    // FIXME: should lexer.fcn_file_name already be
     // preprocessed when we get here?  It seems to only be a
     // problem with relative filenames.
 
--- a/liboctave/cruft/misc/f77-fcn.h	Thu Jan 14 06:20:28 2016 -0500
+++ b/liboctave/cruft/misc/f77-fcn.h	Thu Jan 14 07:02:41 2016 -0800
@@ -171,8 +171,8 @@
 #define F77_NORETURN(retval) return retval;
 #endif
 
-/* FIXME -- these should work for SV1 or Y-MP systems but will
-   need to be changed for others.  */
+/* FIXME: These should work for SV1 or Y-MP systems but will
+          need to be changed for others.  */
 
 typedef union
 {
--- a/liboctave/numeric/lo-specfun.cc	Thu Jan 14 06:20:28 2016 -0500
+++ b/liboctave/numeric/lo-specfun.cc	Thu Jan 14 07:02:41 2016 -0800
@@ -3932,8 +3932,8 @@
       // When n is 1: do nothing since ((-1)**(n+1)/gamma(n+1)) == 1
       // When n is 0: change sign since ((-1)**(n+1)/gamma(n+1)) == -1
       if (n > 1)
-        // FIXME xgamma here is a killer for our precision since it grows
-        //       way too fast
+        // FIXME: xgamma here is a killer for our precision since it grows
+        //        way too fast.
         ans = ans / (pow (-1.0, n + 1) / xgamma (double (n+1)));
       else if (n == 0)
         ans = -ans;
--- a/liboctave/numeric/randmtzig.c	Thu Jan 14 06:20:28 2016 -0500
+++ b/liboctave/numeric/randmtzig.c	Thu Jan 14 07:02:41 2016 -0800
@@ -166,7 +166,7 @@
 #include "lo-math.h"
 #include "randmtzig.h"
 
-/* FIXME may want to suppress X86 if sizeof(long) > 4 */
+/* FIXME: may want to suppress X86 if sizeof(long) > 4 */
 #if ! defined (USE_X86_32)
 # if defined (i386) || defined (HAVE_X86_32)
 #  define USE_X86_32 1
--- a/liboctave/numeric/randpoisson.c	Thu Jan 14 06:20:28 2016 -0500
+++ b/liboctave/numeric/randpoisson.c	Thu Jan 14 07:02:41 2016 -0800
@@ -535,8 +535,8 @@
     }
   else if (INFINITE(L))
     {
-      /* FIXME R uses NaN, but the normal approx. suggests that as
-       * limit should be inf. Which is correct? */
+      /* FIXME: R uses NaN, but the normal approximation suggests that
+       * limit should be Inf.  Which is correct? */
       ret = NAN;
     }
   else
@@ -608,8 +608,8 @@
     }
   else if (INFINITE(L))
     {
-      /* FIXME R uses NaN, but the normal approx. suggests that as
-       * limit should be inf. Which is correct? */
+      /* FIXME: R uses NaN, but the normal approximation suggests that
+       * limit should be Inf. Which is correct? */
       ret = NAN;
     }
   else
--- a/liboctave/util/lo-ieee.h	Thu Jan 14 06:20:28 2016 -0500
+++ b/liboctave/util/lo-ieee.h	Thu Jan 14 07:02:41 2016 -0800
@@ -45,8 +45,8 @@
 /* Octave's idea of not a number.  */
 #define octave_Float_NaN (lo_ieee_float_nan_value ())
 
-/* FIXME -- this code assumes that a double has twice the
-   number of bits as an int */
+/* FIXME: This code assumes that a double has twice the
+          number of bits as an int */
 
 typedef union
 {
--- a/liboctave/util/oct-rl-edit.c	Thu Jan 14 06:20:28 2016 -0500
+++ b/liboctave/util/oct-rl-edit.c	Thu Jan 14 07:02:41 2016 -0800
@@ -89,8 +89,7 @@
 
    Instead, temporarily redefine the redisplay function to do nothing.
 
-   FIXME -- It would be safer to do this when protected from
-   interrupts... */
+   FIXME: It would be safer to do this when protected from interrupts... */
 
 static void
 flush_stdout (void)
--- a/liboctave/util/sparse-util.h	Thu Jan 14 06:20:28 2016 -0500
+++ b/liboctave/util/sparse-util.h	Thu Jan 14 07:02:41 2016 -0800
@@ -24,10 +24,9 @@
 #if ! defined (octave_sparse_util_h)
 #define octave_sparse_util_h 1
 
-// The next two functions don't do anything unless CHOLMOD is
-// available
+// The next two functions don't do anything unless CHOLMOD is available
 
-// FIXME this overload is here due to API change in SuiteSparse (3.1 -> 3.2)
+// FIXME: This overload is here due to API change in SuiteSparse (3.1 -> 3.2)
 extern OCTAVE_API void
 SparseCholError (int status, char *file, int line, char *message);