diff --git a/docs/Getting-Started-Guides/AWS-EC2-F1-Getting-Started/Initial-Setup/Background-Terminology.rst b/docs/Getting-Started-Guides/AWS-EC2-F1-Getting-Started/Initial-Setup/Background-Terminology.rst index 956c85ae..ee01ea4a 100644 --- a/docs/Getting-Started-Guides/AWS-EC2-F1-Getting-Started/Initial-Setup/Background-Terminology.rst +++ b/docs/Getting-Started-Guides/AWS-EC2-F1-Getting-Started/Initial-Setup/Background-Terminology.rst @@ -1,4 +1,10 @@ Background/Terminology ============================== +.. |mach_or_inst| replace:: Instance +.. |mach_or_inst_l| replace:: instance +.. |mach_details| replace:: an AWS EC2 instance +.. |mach_or_inst2| replace:: cloud instance +.. |simple_setup| replace:: + .. include:: ../../Terminology-Template.rst diff --git a/docs/Getting-Started-Guides/On-Premises-FPGA-Getting-Started/Initial-Setup/Xilinx-XDMA-Template.rst b/docs/Getting-Started-Guides/On-Premises-FPGA-Getting-Started/Initial-Setup/Xilinx-XDMA-Template.rst index a45f0f5d..0c47d115 100644 --- a/docs/Getting-Started-Guides/On-Premises-FPGA-Getting-Started/Initial-Setup/Xilinx-XDMA-Template.rst +++ b/docs/Getting-Started-Guides/On-Premises-FPGA-Getting-Started/Initial-Setup/Xilinx-XDMA-Template.rst @@ -4,6 +4,12 @@ Initial Setup/Installation Background/Terminology -------------------------- +.. |mach_or_inst| replace:: Machine +.. |mach_or_inst_l| replace:: machine +.. |mach_details| replace:: your local desktop or server +.. |mach_or_inst2| replace:: local machine +.. |simple_setup| replace:: In the simplest setup, a single host machine (e.g. your desktop) can serve the function of all three of these: as the manager machine, the build farm machine (assuming Vivado is installed), and the run farm machine (assuming an FPGA is attached). + .. include:: ../../Terminology-Template.rst diff --git a/docs/Getting-Started-Guides/Terminology-Template.rst b/docs/Getting-Started-Guides/Terminology-Template.rst index 18250faf..654cad4f 100644 --- a/docs/Getting-Started-Guides/Terminology-Template.rst +++ b/docs/Getting-Started-Guides/Terminology-Template.rst @@ -32,29 +32,26 @@ on the simulated RISC-V system (*target*-software) or on a host x86 machine (*ho Machines used to build and run FireSim simulations are broadly classified into three groups: -**Manager Machine/Instance** - This is the main host machine (e.g., your local desktop or an AWS EC2 - instance) that you will "do work" on. This is where you'll clone your copy of - FireSim and use the FireSim Manager to deploy builds/simulations from. +**Manager |mach_or_inst|** + This is the main host machine (e.g., |mach_details|) that you will "do work" + on. This is where you'll clone your copy of FireSim and use the FireSim + Manager to deploy builds/simulations from. -**Build Farm Machines/Instances** - These are local machines ("build farm machines") or cloud instances ("build - farm instances") that are used by the FireSim manager to run FPGA bitstream - builds. The manager will automatically ship all sources necessary to run - builds to these machines and will run the Verilog to FPGA bitstream build - process on them. +**Build Farm |mach_or_inst|s** + These are a collection of |mach_or_inst2|s ("build farm |mach_or_inst_l|s") + that are used by the FireSim manager to run FPGA bitstream builds. The + manager will automatically ship all sources necessary to run builds to these + |mach_or_inst_l| and will run the Verilog to FPGA bitstream build process on + them. -**Run Farm Machines/Instances** - These are a collection of local machines ("run farm machines") or cloud - instances ("run farm instances") with FPGAs attached that the manager manages - and deploys simulations onto. You can use multiple Run Farms in parallel to - run multiple separate simulations in parallel. +**Run Farm |mach_or_inst|s** + These are a collection of |mach_or_inst2|s ("run farm |mach_or_inst_l|s") + with FPGAs attached that the manager manages and deploys simulations onto. + You can use multiple Run Farms in parallel to run multiple separate + simulations in parallel. -In the simplest setup, a single host machine (e.g. your desktop) can serve -the function of all three of these: as the manager machine, the build farm -machine (assuming Vivado is installed), and the run farm machine (assuming -an FPGA is attached). +|simple_setup| One final piece of terminology will also be referenced throughout these docs: