[m-rev.] diff: hide documentation for more experimental grade components

Julien Fischer jfischer at opturion.com
Fri Apr 17 00:42:05 AEST 2015


Hide documentation for more experimental grade components.

compiler/options.m:
 	Hide the documentation for the .tsw and .tsc grade components.
 	They are experimental and not useful for non-developers.

 	Fix an error introduced in my last change: hlc is also a valid base
 	grade for '--target c'.

doc/user_guide.texi:
 	Conform to the above change.

Julien.

diff --git a/compiler/options.m b/compiler/options.m
index d28938d..10ecc62 100644
--- a/compiler/options.m
+++ b/compiler/options.m
@@ -4343,7 +4343,7 @@ options_help_compilation_model -->
          %"--target c\t\t\t(grades: none, reg, jump, fast,",
          %"\t\t\t\t\tasm_jump, asm_fast, hl, hlc)",
          %"--target il\t\t\t(grades: il)",
-        "--target c\t\t\t(grades: none, reg, asm_fast)",
+        "--target c\t\t\t(grades: none, reg, asm_fast, hlc)",
          "--target csharp\t\t\t(grades: csharp)",
          "--target java\t\t\t(grades: java)",
          "--target erlang\t\t\t(grades: erlang)",
@@ -4508,10 +4508,11 @@ options_help_compilation_model -->
          "\t--profile-for-implicit-parallelism is a deprecated synonym for",
          "\tthis option",

-        "--record-term-sizes-as-words\t\t(grade modifier: `.tsw')",
-        "\tAugment each heap cell with its size in words.",
-        "--record-term-sizes-as-cells\t\t(grade modifier: `.tsc')",
-        "\tAugment each heap cell with its size in cells.",
+        % These are commented out as this feature is still experimental.
+        %"--record-term-sizes-as-words\t\t(grade modifier: `.tsw')",
+        %"\tAugment each heap cell with its size in words.",
+        %"--record-term-sizes-as-cells\t\t(grade modifier: `.tsc')",
+        %"\tAugment each heap cell with its size in cells.",

          "--experimental-complexity <filename>",
          "\tEnable experimental complexity analysis for the predicates",
diff --git a/doc/user_guide.texi b/doc/user_guide.texi
index 1321449..a5aa49a 100644
--- a/doc/user_guide.texi
+++ b/doc/user_guide.texi
@@ -7841,11 +7841,11 @@ and grade modifier; they are followed by descriptions of those options.
  @item @samp{.trseg}
  @code{--use-trail --trail-segments}.

- at item @samp{.tsw}
- at code{--record-term-sizes-as-words}.
+ at c @item @samp{.tsw}
+ at c @code{--record-term-sizes-as-words}.

- at item @samp{.tsc}
- at code{--record-term-sizes-as-cells}.
+ at c @item @samp{.tsc}
+ at c @code{--record-term-sizes-as-cells}.

  @item @samp{.spf}
  @code{--single-prec-float}
@@ -8184,7 +8184,6 @@ is that the former method can give slightly more accurate timing results.
  because with the latter method the code inserted to record call counts
  has a small effect on the execution speed.

- at end ignore

  @sp 1
  @item @code{--record-term-sizes-as-words} (grades: any grade containing @samp{.tsw})
@@ -8196,6 +8195,8 @@ Record the sizes of terms, using one word as the unit of memory.
  @findex --record-term-sizes-as-cells
  Record the sizes of terms, using one cell as the unit of memory.

+ at end ignore
+
  @sp 1
  @item @code{--experimental-complexity @var{filename}}
  @findex --experimental-complexity



More information about the reviews mailing list