Difference between revisions of "Synchronize Configuration"

From VSI OpenVMS Wiki
Jump to: navigation, search
(Settings Description)
 
(8 intermediate revisions by 4 users not shown)
Line 6: Line 6:
 
         "keepAlive": false,
 
         "keepAlive": false,
 
         "preferZip": false,
 
         "preferZip": false,
 +
        "forceLocalTime": true,
 
         "purge": false,
 
         "purge": false,
         "setTimeAttempts": 3,
+
         "setTimeAttempts": 3
        "setTimeByShell": true,
 
        "unzipCmd": ""
 
 
     }
 
     }
 
}
 
}
 
</pre>
 
</pre>
 +
 +
=Important notes=
 +
Only files matched <code>'''source'''</code>, <code>'''headers'''</code>, <code>'''builders'''</code> and <code>'''resource'''</code> but not matched <code>'''exclude'''</code> will be synchronized. How to adjust these settings see [[Project Settings]]
  
 
=Settings Description=
 
=Settings Description=
Line 18: Line 20:
 
** '''overwrite''' - remote files will overwrite local files.
 
** '''overwrite''' - remote files will overwrite local files.
 
** '''skip''' - remote files will not be downloaded but an appropriate warning message will be shown.
 
** '''skip''' - remote files will not be downloaded but an appropriate warning message will be shown.
** '''edit''' - remote files will be downloaded into memory and the edit-merge window will be opened to allow user decide what changes to save.
+
** '''edit''' - remote files will be downloaded into memory and the edit-merge window will be opened to allow the user decide what changes to save.
 
* <code>'''keepAlive'''</code> - Shell and SFTP connections will not be closed after synchronization is done and will be reused for the next synchronization.
 
* <code>'''keepAlive'''</code> - Shell and SFTP connections will not be closed after synchronization is done and will be reused for the next synchronization.
 
* <code>'''preferZip'''</code> - Prefer ZIP for uploading source files.
 
* <code>'''preferZip'''</code> - Prefer ZIP for uploading source files.
 +
* <code>'''forceLocalTime'''</code> - Set local time instead of UTC for archived files. Used when synchronizing via ZIP.
 
* <code>'''purge'''</code> - Execute <code>PURGE</code> command after uploading source.
 
* <code>'''purge'''</code> - Execute <code>PURGE</code> command after uploading source.
 
* <code>'''setTimeAttempts'''</code> - The maximum number of attempts to set file time. '''NOTE''': the first attempt to set file time may be rejected because the file is busy. VMS IDE will re-try to set time again.  
 
* <code>'''setTimeAttempts'''</code> - The maximum number of attempts to set file time. '''NOTE''': the first attempt to set file time may be rejected because the file is busy. VMS IDE will re-try to set time again.  
* <code>'''setTimeByShell'''</code> - If SFTP server on OpenVMS host didn't set the file time, VMS IDE can use shell command to do this.
+
 
* <code>'''unzipCmd'''</code> - Is used to run user defined command to unzip archive, default is <code>unzip -oo "-D"</code> and file name added at the end.
+
If you have the full project on OpenVMS and want to download it to your local machine, set <code>'''downloadNewFiles'''</code> to '''overwrite'''.<br>
 +
If you have the full project on your local machine and use OpenVMS only for compiling and debugging, set <code>'''downloadNewFiles'''</code> to '''skip'''.<br>
 +
If the project on OpenVMS can be changed outside and may be newer than the local copy, set <code>'''downloadNewFiles'''</code> to '''edit'''.<br>
 +
 
 +
[[Category:VMS IDE]]

Latest revision as of 04:23, 16 March 2020

Synchronize Configuration Example

{
    "synchronize": {
        "downloadNewFiles": "edit",
        "keepAlive": false,
        "preferZip": false,
        "forceLocalTime": true,
        "purge": false,
        "setTimeAttempts": 3
    }
}

Important notes

Only files matched source, headers, builders and resource but not matched exclude will be synchronized. How to adjust these settings see Project Settings

Settings Description

  • downloadNewFiles - Strategy for downloading remote files which are newer than local copies.
    • overwrite - remote files will overwrite local files.
    • skip - remote files will not be downloaded but an appropriate warning message will be shown.
    • edit - remote files will be downloaded into memory and the edit-merge window will be opened to allow the user decide what changes to save.
  • keepAlive - Shell and SFTP connections will not be closed after synchronization is done and will be reused for the next synchronization.
  • preferZip - Prefer ZIP for uploading source files.
  • forceLocalTime - Set local time instead of UTC for archived files. Used when synchronizing via ZIP.
  • purge - Execute PURGE command after uploading source.
  • setTimeAttempts - The maximum number of attempts to set file time. NOTE: the first attempt to set file time may be rejected because the file is busy. VMS IDE will re-try to set time again.

If you have the full project on OpenVMS and want to download it to your local machine, set downloadNewFiles to overwrite.
If you have the full project on your local machine and use OpenVMS only for compiling and debugging, set downloadNewFiles to skip.
If the project on OpenVMS can be changed outside and may be newer than the local copy, set downloadNewFiles to edit.