.. -----------------------------------------------------------------------------
   ..
   ..  Filename       : index.rst
   ..  Author         : Huang Leilei
   ..  Status         : draft
   ..  Created        : 2026-03-03
   ..  Description    : about script
   ..
.. -----------------------------------------------------------------------------

About Script
============

   Directory *script* contains **two** scripts.

*  :runListUpdate: a script-based update list
*  :runListcheck: a script-based check list


Update Script
-------------

*  Function

   #. update auto-generated codes like *calc_knl_reg.v*
   #. convert files from DOS format to UNIX format
   #. delete trailing blanks
   #. collect markers like *TODO*, *NOTE*, *???* or *!!!*
   #. collect file status (draft, phase ??? or something alike)
   #. remove empty directory

*  Dependency

      none

*  Content

      .. table::
         :align: left
         :widths: auto

         ================== ====================================== ============
          item               description                            postscript
         ================== ====================================== ============
          runListUpdate.sh   3.8.10
          dump               directory for collected informations   generated by command *./runListUpdate.sh*
         ================== ====================================== ============

*  Usage

      |  In WSL environment, change directory to *script*,
      |  then you can

   #. try the above functions with

      ::

         ./runListUpdate.sh

      then you will get

      .. +++++++++++ uncommented to help the decision of width

      .. image:: runListUpdate_0.png
         :width: 295

      \

      .. +++++++++++ uncommented to help the decision of width

      .. image:: runListUpdate_1.png
         :width: 495

Check Script
------------

*  Function

   #. check format of file header
   #. check include of *define\*.vh* and *undef\*.vh*
   #. check formats of module declarations
   #. check extra comma
   #. check parameter, input, output, reg, and wire declarations
   #. check assignment
   #. check bit operation
   #. check expression in square bracket
   #. check digital prefix
   #. check unreferenced variable

*  Dependency

      .. table::
         :align: left
         :widths: auto

         ====== ============
          item   my version
         ====== ============
          Perl   v5.30.0
         ====== ============

*  Content

      .. table::
         :align: left
         :widths: auto

         ================= ====================================== ============
          item              description                            postscript
         ================= ====================================== ============
          runListCheck.sh   3.8.10
          dump              directory for collected informations   generated by command *./runListCheck.sh*
         ================= ====================================== ============

*  Usage

      |  In WSL environment, change directory to *script*,
      |  then you can

   #. try the above functions with

      ::

         ./runListCheck.sh

      then you will get

      .. +++++++++++ uncommented to help the decision of width

      .. image:: runListCheck_0.png
         :width: 450

      \

      .. +++++++++++ uncommented to help the decision of width

      .. image:: runListCheck_1.png
         :width: 205
