update_files - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2024-05-30
Version
2024.1 English

Update file(s) in the project based on the file(s) or directory(ies) specified

Syntax

update_files [‑from_files <args>] [‑norecurse] [‑to_files <args>]
    [‑filesets <args>] [‑force] [‑report_only] [‑quiet] [‑verbose]

Returns

List of the files updated.

Usage

Name Description
[-from_files] New files and directories to use for updating
[-norecurse] Recursively search in specified directories
[-to_files] Existing project files and directories to limit updates to
[-filesets] Fileset name
[-force] Overwrite imported files in the project, even if read-only, if possible
[-report_only] Do no actual file updates, but report on updates that otherwise would have been made
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution

Categories

Project

Description

Updates the specified files with the contents of specified remote files. Use this command to update a local file with the contents of its original remote file, or replace it with the contents of a different remote file.

This command returns a list of updated files, or returns an error if it fails.

Arguments

-from_files <args> - (Optional) An ordered list of files or directories to use when updating the -to_files to be updated.

-norecurse - (Optional) Disable recursive searching through specified sub-directories.

-to_files <args> - (Optional) The path and filename of the file or files to update with the specified -from_files.

-filesets <args> - (Optional) Overwrite the files in the specified fileset with the -from_files.

-force - (Optional) Force the overwrite of specified files, even if they are write restricted.

-report_only - (Optional) Run the command a generate a report related to updated files, but do no actually update the files.

-quiet - (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
Note: Message limits can be defined with the set_msg_config command.

Examples

The following example updates the various project source IP core files with the specified -from_files, reporting the results without making any updates:

update_files -from_files C:/Data/IP/*.xci \
   -to_file [get_files *.xci} -report_only
Note: No warnings will be issued for newer local files that will be overwritten.

See Also