kernel: update some comments

src/sysopt.h

@@ -49,12 +49,14 @@ extern const char * SyCompileMagic1;
 */
 extern Int SyDebugLoading;
 
+
 /****************************************************************************
 **
 *F  SyDotGapPath()
 */
 const Char * SyDotGapPath(void);
 
+
 /****************************************************************************
 **
 *V  SyLineEdit  . . . . . . . . . . . . . . . . . . . .  support line editing
@@ -65,6 +67,7 @@ const Char * SyDotGapPath(void);
 */
 extern UInt SyLineEdit;
 
+
 /****************************************************************************
 **
 *V  SyUseReadline   . . . . . . . . . . . . . . . . . .  support line editing
@@ -73,6 +76,7 @@ extern UInt SyLineEdit;
 */
 extern UInt SyUseReadline;
 
+
 /****************************************************************************
 **
 *V  SyNrCols  . . . . . . . . . . . . . . . . . .  length of the output lines
@@ -85,11 +89,12 @@ extern UInt SyUseReadline;
 **  'Pr' uses this to decide where to insert a <newline> on the output lines.
 **  'SyRead' uses it to decide when to start scrolling the echoed input line.
 **
-**  Put in this package because the command line processing takes place here.
+**  See also InitWindowSize().
 */
 extern UInt SyNrCols;
 extern UInt SyNrColsLocked;
 
+
 /****************************************************************************
 **
 *V  SyNrRows  . . . . . . . . . . . . . . . . . number of lines on the screen
@@ -99,7 +104,7 @@ extern UInt SyNrColsLocked;
 **  Per default this is 24, which is the  usual  size  of  terminal  screens.
 **  It can be changed with the '-y' option for larger terminals or  printers.
 **
-**  'SyHelp' uses this to decide where to stop with '-- <space> for more --'.
+**  See also InitWindowSize().
 */
 extern UInt SyNrRows;
 extern UInt SyNrRowsLocked;
@@ -109,7 +114,7 @@ extern UInt SyNrRowsLocked;
 **
 *V  SyQuiet . . . . . . . . . . . . . . . . . . . . . . . . . suppress prompt
 **
-**  'SyQuit' determines whether GAP should print the prompt and  the  banner.
+**  'SyQuiet' determines whether GAP should print the prompt and the  banner.
 **
 **  Per default its false, i.e. GAP prints the prompt and  the  nice  banner.
 **  It can be changed by the '-q' option to have GAP operate in silent  mode.
@@ -120,6 +125,7 @@ extern UInt SyNrRowsLocked;
 */
 extern UInt SyQuiet;
 
+
 /****************************************************************************
 **
 *V  SyQuitOnBreak . . . . . . . . . . exit GAP instead of entering break loop
@@ -133,6 +139,7 @@ extern UInt SyQuiet;
 */
 extern UInt SyQuitOnBreak;
 
+
 /****************************************************************************
 **
 *V  SyRestoring . . . . . . . . . . . . . . . . . . . . restoring a workspace
@@ -146,6 +153,7 @@ extern UInt SyQuitOnBreak;
 extern Char * SyRestoring;
 #endif
 
+
 /****************************************************************************
 **
 *V  SyInitializing                               set to 1 during library init

src/system.c

@@ -107,6 +107,7 @@ static Char DotGapPath[GAP_PATH_MAX];
 */
 static Int IgnoreGapRC;
 
+
 /****************************************************************************
 **
 *V  SyLineEdit  . . . . . . . . . . . . . . . . . . . .  support line editing
@@ -117,6 +118,7 @@ static Int IgnoreGapRC;
 */
 UInt SyLineEdit;
 
+
 /****************************************************************************
 **
 *V  SyUseReadline   . . . . . . . . . . . . . . . . . .  support line editing
@@ -125,6 +127,7 @@ UInt SyLineEdit;
 */
 UInt SyUseReadline;
 
+
 /****************************************************************************
 **
 *V  SyNrCols  . . . . . . . . . . . . . . . . . .  length of the output lines
@@ -138,12 +141,11 @@ UInt SyUseReadline;
 **  'SyRead' uses it to decide when to start scrolling the echoed input line.
 **
 **  See also InitWindowSize().
-**
-**  Put in this package because the command line processing takes place here.
 */
 UInt SyNrCols;
 UInt SyNrColsLocked;
 
+
 /****************************************************************************
 **
 *V  SyNrRows  . . . . . . . . . . . . . . . . . number of lines on the screen
@@ -153,13 +155,12 @@ UInt SyNrColsLocked;
 **  Per default this is 24, which is the  usual  size  of  terminal  screens.
 **  It can be changed with the '-y' option for larger terminals or  printers.
 **
-**  'SyHelp' uses this to decide where to stop with '-- <space> for more --'.
-**
 **  See also InitWindowSize().
 */
 UInt SyNrRows;
 UInt SyNrRowsLocked;
 
+
 /****************************************************************************
 **
 *V  SyQuiet . . . . . . . . . . . . . . . . . . . . . . . . . suppress prompt
@@ -175,17 +176,26 @@ UInt SyNrRowsLocked;
 */
 UInt SyQuiet;
 
+
 /****************************************************************************
 **
 *V  SyQuitOnBreak . . . . . . . . . . exit GAP instead of entering break loop
+**
+**  'SyQuitOnBreak' determines whether GAP should quit (with non-zero return
+**  value) instead of entering the break loop.
+**
+**  False by default, can be changed with the '--quitonbreak' option.
+**
+**  Put in this package because the command line processing takes place here.
 */
 UInt SyQuitOnBreak;
 
+
 /****************************************************************************
 **
 *V  SyRestoring . . . . . . . . . . . . . . . . . . . . restoring a workspace
 **
-**  `SyRestoring' determines whether GAP is restoring a workspace or not.  If
+**  'SyRestoring' determines whether GAP is restoring a workspace or not.  If
 **  it is zero no restoring should take place otherwise it holds the filename
 **  of a workspace to restore.
 **
@@ -199,7 +209,7 @@ Char * SyRestoring;
 **
 *V  SyInitializing                               set to 1 during library init
 **
-**  `SyInitializing' is set to 1 during the library initialization phase of
+**  'SyInitializing' is set to 1 during the library initialization phase of
 **  startup. It suppresses some behaviours that may not be possible so early
 **  such as homogeneity tests in the plist code.
 */