From a678c81b4c13f4ae418bf810f77875dd113210bf Mon Sep 17 00:00:00 2001
From: stefan schippers <stefan.schippers@gmail.com>
Date: Thu, 7 Sep 2023 20:25:08 +0200
Subject: [PATCH] update documentation for change in return code of "xschem
 switch" command

---
 doc/xschem_man/developer_info.html | 7 +++++--
 src/scheduler.c                    | 4 +++-
 2 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/doc/xschem_man/developer_info.html b/doc/xschem_man/developer_info.html
index 7017a355..a8605e52 100644
--- a/doc/xschem_man/developer_info.html
+++ b/doc/xschem_man/developer_info.html
@@ -648,6 +648,7 @@ C {verilog_timescale.sym} 1050 -100 0 0 {name=s1 timestep="1ns" precision="1ns"
      <li><kbd> gridlayer </kbd> layer number for grid </li>
      <li><kbd> help </kbd> command help </li>
      <li><kbd> header_text </kbd> header metadata (license info etc) present in schematic </li>
+     <li><kbd> infowindow_text </kbd> ERC messages </li>
      <li><kbd> instances </kbd> number of instances in schematic </li>
      <li><kbd> lastsel </kbd> number of selected objects </li>
      <li><kbd> line_width </kbd> get line width </li>
@@ -1097,6 +1098,7 @@ C {verilog_timescale.sym} 1050 -100 0 0 {name=s1 timestep="1ns" precision="1ns"
      <li><kbd> format </kbd> set name of custom format attribute used for netlisting </li>
      <li><kbd> header_text </kbd> set header metadata (used for license info) </li>
      <li><kbd> hide_symbols </kbd> set to 0,1,2 for various hiding level of symbols </li>
+     <li><kbd> infowindow_text </kbd> ERC messages </li>
      <li><kbd> netlist_name </kbd> set custom netlist name </li>
      <li><kbd> netlist_type </kbd> set netlisting mode (spice, verilog, vhdl, tedax, symbol) </li>
      <li><kbd> no_draw </kbd> set no drawing flag (0 or 1) </li>
@@ -1160,7 +1162,9 @@ C {verilog_timescale.sym} 1050 -100 0 0 {name=s1 timestep="1ns" precision="1ns"
    if 'new_process' is given start a new xschem process </pre>
    <li><kbd>       switch [window_path |schematic_name]</kbd></li><pre>
    Switch context to indicated window path or schematic name
-   returns the # of windows/tabs in addition to main window/tab</pre>
+   returns 0 if switch was successfull or 1 in case of errors
+   (no tabs/windows present or no matching winpath / schematic name
+   found).</pre>
    <li><kbd>       symbols [n]</kbd></li><pre>
    if 'n' given list symbol with name or number 'n', else 
    list all used symbols </pre>
@@ -1266,7 +1270,6 @@ C {verilog_timescale.sym} 1050 -100 0 0 {name=s1 timestep="1ns" precision="1ns"
 
 
 
-
  </ul>
 
   <!-- TCL global variables -->
diff --git a/src/scheduler.c b/src/scheduler.c
index 3c1d2b8b..606c9b5f 100644
--- a/src/scheduler.c
+++ b/src/scheduler.c
@@ -3829,7 +3829,9 @@ int xschem(ClientData clientdata, Tcl_Interp *interp, int argc, const char * arg
 
     /* switch [window_path |schematic_name]
      *   Switch context to indicated window path or schematic name
-     *   returns the # of windows/tabs in addition to main window/tab
+     *   returns 0 if switch was successfull or 1 in case of errors
+     *   (no tabs/windows present or no matching winpath / schematic name
+     *   found).
      */
     else if(!strcmp(argv[1], "switch"))
     {