feat: On SortVerbose

doc/manual/sorting.tex

@@ -214,6 +214,25 @@ \chapter{Sorting and statistics}
 
 The sizes of buffers involved can all be tuned to a given hardware. How 
 this is done is explained in the chapter on the setup\index{setup} \ref{setup}.
+By specifying \texttt{On SortVerbose;}\index{on!sortverbose} (see
+\ref{substaon}), more information is printed in the final sorting statistics of
+each expression, which take the form:
+\begin{verbatim}
+Time =       0.00 sec    Generated terms =         64
+           test1         Terms in output =         64
+                         Bytes used      =       4888
+                         Unsorted bytes  =       6144
+                         Small Buffer    =    0,    0
+                         Large Buffer    =    0,    0
+                         Comparisons     =         63
+\end{verbatim}
+The additional information includes the total size of the generated terms
+before cancellations, merging or compression, the number of times the small
+buffer was sorted due to reaching TermsInSmall, or SmallSize, the number of
+times the large buffer was sorted due to reaching LargePatches, or LargeSize,
+and the total number of term comparisons made during the sort. In particular,
+the information on why the small and large buffers were sorted helps when
+configuring their sizes, as described in \ref{setup}.
 
 When \FORM\ is dealing with the arguments\index{arguments of functions} of 
 functions and if an argument is a multiterm subexpression, also such 

doc/manual/statements.tex

@@ -3868,6 +3868,10 @@ \section{off}
 \leftvitem{3.5cm}{sortreallocate\index{off!sortreallocate}}
 \rightvitem{13cm}{Turns off the reallocation of the small and large buffer
 at the end of each module.}
+
+\leftvitem{3.5cm}{sortverbose\index{off!sortverbose}}
+\rightvitem{13cm}{Turns off the printing of additional information in the
+sorting statistics.}
 
 \leftvitem{3.5cm}{threadloadbalancing\index{off!threadloadbalancing}}
 \rightvitem{13cm}{\vspace{1.5ex}Disables the loadbalancing mechanism of 
@@ -4091,6 +4095,10 @@ \section{on}
 noticable performance penalty. See also \#sortreallocate (\ref{presortreallocate})
 for a single-module version of this feature.}
 
+\leftvitem{3.5cm}{sortverbose\index{on!sortverbose}}
+\rightvitem{13cm}{Turns on the printing of additional information in the
+sorting statistics. See \ref{sorting} for more information.}
+
 \leftvitem{3.5cm}{statistics\index{on!statistics}}
 \rightvitem{13cm}{Turns the writing of runtime statistics on. This is the 
 default. It is possible to change this default with one of the setup 

sources/compcomm.c

@@ -143,6 +143,7 @@ static KEYWORDV onoffoptions[] = {
 	,{"humanstats",	&(AC.HumanStatsFlag), 1, 0}
 	,{"humanstatistics",	&(AC.HumanStatsFlag), 1, 0}
 	,{"grccverbose", &(AC.GrccVerbose), 1, 0}
+	,{"sortverbose", &(AC.SortVerbose), 1, 0}
 };
 
 static WORD one = 1;