Skip to content

Commit 79e9ceb

Browse files
committed
Rename unnecessarily long-named checkin and checkout scripts
1 parent 5b6e341 commit 79e9ceb

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ This guide covers only what is required to gain access to and build demo project
4040
1. Once Vivado is open, open the TCL Console at the bottom of the screen.
4141
1. To initialize and open the Vivado project, run the following command in the TCL console, changing `<path>` to match the location of the directory that you noted down in Step 2 of the *Getting Demo Sources* section:
4242

43-
`set argv ""; source <path>/<demo>/scripts/digilent_vivado_checkout.tcl`
43+
`set argv ""; source <path>/<demo>/scripts/checkout.tcl`
4444
1. At this point you now have access to the Vivado Project and all of its sources. The project can be viewed, changes can be made, a bitstream can be generated, and Xilinx shell architecture file (XSA) can be generated for handoff to Vitis.
4545
### Final Notes
4646
At this point, you have access to a working copy of the demo repository. The chosen demo's README or wiki page will contain instructions on how to use this demo once it is programmed onto your board.
@@ -59,7 +59,7 @@ A front-end script, git_vivado.py, is provided to parse command line arguments a
5959
## Commands / Scripts
6060
### Checkout
6161
#### Description
62-
This subcommand calls into digilent_vivado_checkout.tcl in order to create a Vivado project, in the form of an XPR file, using the sources and scripts contained in the project repository.
62+
This subcommand calls into checkout.tcl in order to create a Vivado project, in the form of an XPR file, using the sources and scripts contained in the project repository.
6363
#### Optional Arguments
6464
1. `-r <repo>`: Path to the repository directory. Default: `<digilent-vivado-scripts>/..`
6565
1. `-x <xpr>`: Path to the project .xpr file the repo is to be checked out into. Default: `<repo>/proj/<repo name>.xpr`
@@ -74,12 +74,12 @@ This subcommand calls into digilent_vivado_checkout.tcl in order to create a Viv
7474
##### TCL:
7575
> `set argv "-r D:/Github/Zybo-Z7/hw"`
7676
77-
> `source digilent_vivado_checkout.tcl`
77+
> `source checkout.tcl`
7878
7979
-----------
8080
### Checkin
8181
#### Description
82-
This subcommand calls into digilent_vivado_checkin.tcl in order to collect sources and generate needed scripts from a Vivado project into the repository structure described below. Files required for checkout *that are not already present* in the repository (such as project_info.tcl and gitignores), are automatically created. These files are not overwritten if they already exist.
82+
This subcommand calls into checkin.tcl in order to collect sources and generate needed scripts from a Vivado project into the repository structure described below. Files required for checkout *that are not already present* in the repository (such as project_info.tcl and gitignores), are automatically created. These files are not overwritten if they already exist.
8383
#### Optional Arguments
8484
1. `-r <repo>`: Path to the repository directory. Default: `<digilent-vivado-scripts>/..`
8585
1. `-x <xpr>`: Path to the project .xpr file to be processed for checkin. Default: `<repo>/proj/*.xpr`
@@ -93,7 +93,7 @@ This subcommand calls into digilent_vivado_checkin.tcl in order to collect sourc
9393
##### TCL:
9494
> `set argv "-r D:/Github/Zybo-Z7/hw"`
9595
96-
> `source digilent_vivado_checkin.tcl`
96+
> `source checkin.tcl`
9797
9898
------------------------------------
9999
## Other Files and Overall Structure
@@ -143,7 +143,7 @@ Once the repo exists locally, the Vivado project can be checked out from source.
143143

144144
Alternatively, the project can be checked out from within Vivado, by calling the following command in the TCL console:
145145

146-
* `set argv ""; source ./digilent-vivado-scripts/digilent_vivado_checkout.tcl`
146+
* `set argv ""; source ./digilent-vivado-scripts/checkout.tcl`
147147

148148
Both of these commands create a Vivado project within the repository's `proj` folder. In the case of the Python command, the project then needs to be opened from within Vivado.
149149

File renamed without changes.
File renamed without changes.

git_vivado.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ def do_checkin(args):
1818
DEBUG_VIVADO_TCL_TRACE = args['DEBUG_VIVADO_TCL_TRACE']
1919

2020
vivado_cmd = args['vivado_cmd'].replace('\\', '/')
21-
script_path = os.path.join(args['script_dir'], 'digilent_vivado_checkin.tcl').replace('\\', '/')
21+
script_path = os.path.join(args['script_dir'], 'checkin.tcl').replace('\\', '/')
2222
xpr_path = args['xpr_path'].replace('\\', '/')
2323
repo_path = args['repo_path'].replace('\\', '/')
2424
version = args['version'].replace('\\', '/')
@@ -43,7 +43,7 @@ def do_checkout(args):
4343
DEBUG_VIVADO_TCL_TRACE = args['DEBUG_VIVADO_TCL_TRACE']
4444

4545
vivado_cmd = args['vivado_cmd'].replace('\\', '/')
46-
script_path = os.path.join(args['script_dir'], 'digilent_vivado_checkout.tcl').replace('\\', '/')
46+
script_path = os.path.join(args['script_dir'], 'checkout.tcl').replace('\\', '/')
4747
xpr_path = args['xpr_path'].replace('\\', '/')
4848
repo_path = args['repo_path'].replace('\\', '/')
4949
version = args['version'].replace('\\', '/')

0 commit comments

Comments
 (0)