[m-rev.] diff: adjust formatting in user guide

Julien Fischer jfischer at opturion.com
Sat Jan 9 23:34:26 AEDT 2021


Adjust formatting in the user guide.

doc/user_guide.texi:
    List the detail letters for the --dump-hlds-options argument in
    table; the current (lack of) arrangement is very difficult to read.

Julien.

diff --git a/doc/user_guide.texi b/doc/user_guide.texi
index 6fc6d62..2c90a03 100644
--- a/doc/user_guide.texi
+++ b/doc/user_guide.texi
@@ -7621,45 +7621,84 @@ Multiple dump options accumulate.
  @findex --dump-hlds-options
  With @samp{--dump-hlds}, include extra detail in the dump.
  Each type of detail is included in the dump
-if its corresponding letter occurs in the option argument.
+if its corresponding letter occurs in the @var{options} argument.
  These details are:
-a - argument modes in unifications,
-b - builtin flags on calls,
-c - contexts of goals and types,
-d - determinism of goals,
-e - created, removed, carried, allocated into, and used regions,
-f - follow_vars sets of goals,
-g - goal feature lists,
-i - variables whose instantiation changes,
-l - pred/mode ids and unify contexts of called predicates,
-m - mode information about clauses,
-n - nonlocal variables of goals,
-p - pre-birth, post-birth, pre-death and post-death sets of goals,
-r - resume points of goals,
-s - store maps of goals,
-t - results of termination analysis,
-u - unification categories and other implementation details of unifications,
-v - variable numbers in variable names,
-x - predicate type information.
-y - structured insts in the arg-modes of unification
-z - purity annotations on impure and semipure goals
-A - argument passing information,
-B - mode constraint information,
-C - clause information,
-D - instmap deltas of goals (meaningful only with i),
-E - deep profiling information,
-G - compile-time garbage collection information,
-I - imported predicates,
-L - restrict the output of type table entries to local types only,
-M - mode and inst information,
-O - dependency and dependency ordering information,
-P - goal id and path information,
-R - live forward use, live backward use and reuse possibilities,
-S - information about structure sharing,
-T - type and typeclass information,
-U - unify and compare predicates,
-X - constant structures,
-Z - information about globals structs representing call and answer tables.
+ at table @asis
+ at item @samp{a}
+argument modes in unifications
+ at item @samp{b}
+builtin flags on calls
+ at item @samp{c}
+contexts of goals and types
+ at item @samp{d}
+determinism of goals
+ at item @samp{e}
+created, removed, carried, allocated into, and used regions
+ at item @samp{f}
+follow_vars sets of goals
+ at item @samp{g}
+goal feature lists
+ at item @samp{i}
+variables whose instantiation changes
+ at item @samp{l}
+pred/mode ids and unify contexts of called predicates
+ at item @samp{m}
+mode information about clauses
+ at item @samp{n}
+nonlocal variables of goals
+ at item @samp{p}
+pre-birth, post-birth, pre-death and post-death sets of goals
+ at item @samp{r}
+resume points of goals
+ at item @samp{s}
+store maps of goals
+ at item @samp{t}
+results of termination analysis
+ at item @samp{u}
+unification categories and other implementation details of unifications
+ at item @samp{v}
+variable numbers in variable names
+ at item @samp{x}
+predicate type information
+ at item @samp{y}
+structured insts in the arg-modes of unification
+ at item @samp{z}
+purity annotations on impure and semipure goals
+ at item @samp{A}
+argument passing information
+ at item @samp{B}
+mode constraint information
+ at item @samp{C}
+clause information
+ at item @samp{D}
+instmap deltas of goals (meaningful only with @samp{i})
+ at item @samp{E}
+deep profiling information
+ at item @samp{G}
+compile-time garbage collection information
+ at item @samp{I}
+imported predicates
+ at item @samp{L}
+restrict the output of type table entries to local types only
+ at item @samp{M}
+mode and inst information
+ at item @samp{O}
+dependency and dependency ordering information
+ at item @samp{P}
+goal id and path information
+ at item @samp{R}
+live forward use, live backward use and reuse possibilities
+ at item @samp{S}
+information about structure sharing
+ at item @samp{T}
+type and typeclass information
+ at item @samp{U}
+unify and compare predicates
+ at item @samp{X}
+constant structures
+ at item @samp{Z}
+information about globals structs representing call and answer tables
+ at end table

  @sp 1
  @item --dump-hlds-pred-id @var{predid}


More information about the reviews mailing list