The following are the required naming conventions when working with the Vivado Design Suite. Failing to follow these naming conventions can introduce potential risk to the design or the tool, and cause unpredictable behavior in the design flow.
- Source files names must start with a letter (A-Z, a-z). The file names must contain only alphanumeric characters (A-Z, a-z, 0-9) and underscores (_).
- Output files names must start with a letter (A-Z, a-z). The file names must contain only alphanumeric characters (A-Z, a-z, 0-9) and underscores (_).
- Project names must start with a letter (A-Z, a-z). The file names must contain only alphanumeric characters (A-Z, a-z, 0-9) and underscores (_).
- Project directory names must start with a letter (A-Z, a-z). The file names must contain only alphanumeric characters (A-Z, a-z, 0-9), tilde (~), and underscores (_).
The system does not support the following characters for project, file, or directory names.
- ! # $ % ^ & * ( ) ` ; < > ? , [ ] { } ' " |
- tab (\t)
- return (\r)
- new line (\n)
- / or \ (As part of the directory or file name rather than as a path delimiter)
The directory name does not support this character.
- . (dot as terminal character)
This file/project name does not support this character.
- @Note: The Vivado IDE does not support the @ character for new file or project names. The Vivado IDE does allow an existing file on disk that uses the @ character to be added to a project. The Vivado IDE can open a project that includes the @ character in the project name. Using the Tcl Console, you can create a project with a name that contains the @ character.
The Vivado Design Suite supports the use of forward slashes (/) as path delimiters for both Windows and Linux platforms. The Windows platform only allows backslashes (\) as path delimiters.
Any characters not explicitly mentioned above are not supported for project, file, or directory names.