Skip to content

Commit 40e200b

Browse files
mjthimmmjthimm
authored
Merge pull request #709 from aws/rc/2.0.7
Documentation hotfix
2 parents 1023490 + 6bbc217 commit 40e200b

File tree

4 files changed

+32
-9
lines changed

4 files changed

+32
-9
lines changed

‎User_Guide_AWS_EC2_FPGA_Development_Kit.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The development kit includes example designs to get you familiar with developing
99
- [Comparison to F1](#comparison-to-f1)
1010
- [AWS EC2 F2 FPGA Development Kit](#aws-ec2-f2-fpga-development-kit)
1111
- [Development Environments](#development-environments)
12-
- [Example Links](#example-links)
12+
- [Quick Start Links](#quick-start-links)
1313
- [AWS Shells](#aws-shells)
1414
- [Hardware Development Kit (HDK)](#hardware-development-kit-hdk)
1515
- [Software-Defined Development Environment](#software-defined-development-environment)
@@ -49,19 +49,21 @@ This table lists the F2 development flows currently enabled and supported in the
4949

5050
On-premise environment: Customers can set up a on-premise development environment using 2024.1 AMD tools with their own licenses. Refer to this guide [here](./hdk/docs/on_premise_licensing_help.md) for licensing requirements.
5151

52-
### Example Links
52+
### Quick Start Links
5353

5454
<!-- markdownlint-disable MD033 -->
5555
<table style="text-align: center">
5656
<tr>
5757
<th style="text-align: center">Development Environment</th>
5858
<th style="text-align: center">Example</th>
59+
<th style="text-align: center">Description</th>
5960
<th style="text-align: center">Quick Start Guide</th>
6061
<th style="text-align: center">Resources</th>
6162
</tr>
6263
<tr>
6364
<td style="text-align: center" rowspan="12">HDK</td>
6465
<td style="text-align: center" rowspan="4"><a href="https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_mem_perf">cl_mem_perf</a></td>
66+
<td style="text-align: center" rowspan="4">Demonstrates fine-tuned paths to memory to maximize bandwidth</td>
6567
<td style="text-align: center" rowspan="4"><a href="./hdk/README.md#build-accelerator-afi-using-hdk-design-flow">Guided Example</a></td>
6668
<td style="text-align: center"><a href="./hdk/cl/examples/cl_mem_perf/README.md">Design Spec</a></td>
6769
</tr>
@@ -76,6 +78,7 @@ On-premise environment: Customers can set up a on-premise development environmen
7678
</tr>
7779
<tr>
7880
<td style="text-align: center" rowspan="4"><a href="https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_dram_hbm_dma">cl_dram_hbm_dma</a></td>
81+
<td style="text-align: center" rowspan="4">Demonstrates connectivity to various internal interfaces from the shell</td>
7982
<td style="text-align: center" rowspan="4"></td>
8083
<td style="text-align: center"><a href="./hdk/cl/examples/cl_dram_hbm_dma/README.md">Design Spec</a></td>
8184
</tr>
@@ -90,6 +93,7 @@ On-premise environment: Customers can set up a on-premise development environmen
9093
</tr>
9194
<tr>
9295
<td style="text-align: center" rowspan="4"><a href="https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_sde">cl_sde</a></td>
96+
<td style="text-align: center" rowspan="4"><a href="https://github.com/aws/aws-fpga/blob/f2/sdk/apps/virtual-ethernet/">Demonstrates the use of the Streaming Data Engine (SDE) via the Virtual Ethernet Application</a></td>
9397
<td style="text-align: center" rowspan="4"></td>
9498
<td style="text-align: center"><a href="./hdk/cl/examples/cl_sde/README.md">Design Spec</a></td>
9599
</tr>
@@ -105,6 +109,7 @@ On-premise environment: Customers can set up a on-premise development environmen
105109
<tr>
106110
<td style="text-align: center" rowspan="4">Vitis</td>
107111
<td style="text-align: center" rowspan="4"><a href="https://github.com/Xilinx/Vitis_Accel_Examples/tree/2024.1/hello_world">hello_world</a></td>
112+
<td style="text-align: center" rowspan="4">Demonstrates streaming to the FPGA rather than block transferring</td>
108113
<td style="text-align: center" rowspan="4"><a href="./vitis/README.md">Guided Example</td>
109114
<td style="text-align: center"><a href="https://github.com/Xilinx/Vitis_Accel_Examples/blob/main/hello_world/README.rst">Design Spec</a></td>
110115
</tr>

‎docs-rtd/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ html:
4545
$(SPHINXBUILD) -a -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
4646
@echo
4747
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
48+
cp source/google28e4accdfd74ffc3.html build/html
4849

4950
dirhtml:
5051
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

‎docs-rtd/source/User-Guide-AWS-EC2-FPGA-Development-Kit.rst

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ developing for AWS EC2 FPGA Instances.
1717
Kit <#aws-ec2-f2-fpga-development-kit>`__
1818

1919
- `Development Environments <#development-environments>`__
20-
- `Example Links <#example-links>`__
20+
- `Quick Start Links <#quick-start-links>`__
2121
- `AWS Shells <#aws-shells>`__
2222
- `Hardware Development Kit (HDK) <#hardware-development-kit-hdk>`__
2323
- `Software-Defined Development
@@ -134,80 +134,97 @@ environment using 2024.1 AMD tools with their own licenses. Refer to
134134
this guide `here <./hdk/docs/on-premise-licensing-help.html>`__ for
135135
licensing requirements.
136136

137-
.. _example-links:
137+
.. _quick-start-links:
138138

139-
Example Links
140-
~~~~~~~~~~~~~
139+
Quick Start Links
140+
~~~~~~~~~~~~~~~~~
141141

142142
.. list-table::
143143
:header-rows: 1
144-
:widths: 15 15 30 35
144+
:widths: 15 15 30 15 25
145145

146146
* - Development Environment
147147
- Example
148+
- Description
148149
- Quick-Start Guide
149150
- Resources
150151
* - HDK
151152
- `cl_mem_perf <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_mem_perf>`__
153+
- Demonstrates fine-tuned paths to memory to maximize bandwidth
152154
- `Guided Example <./hdk/README.html#getting-started-hdk>`__
153155
- `Design Spec <./hdk/cl/examples/cl-mem-perf/README.html>`__
154156
* -
157+
-
155158
-
156159
-
157160
- `Design Source Code <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_mem_perf/design>`__
158161
* -
162+
-
159163
-
160164
-
161165
- `Testbench <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_mem_perf/verif>`__
162166
* -
167+
-
163168
-
164169
-
165170
- `Runtime Software <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_mem_perf/software>`__
166171
* -
167172
- `cl_dram_hbm_dma <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_dram_hbm_dma>`__
173+
- Demonstrates connectivity to various internal interfaces from the shell
168174
-
169175
- `Design Spec <./hdk/cl/examples/cl-dram-hbm-dma/README.html>`__
170176
* -
177+
-
171178
-
172179
-
173180
- `Design Source Code <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_dram_hbm_dma/design>`__
174181
* -
182+
-
175183
-
176184
-
177185
- `Testbench <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_dram_hbm_dma/verif>`__
178186
* -
187+
-
179188
-
180189
-
181190
- `Runtime Software <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_dram_hbm_dma/software>`__
182191
* -
183192
- `cl_sde <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_sde>`__
193+
- `Demonstrates the use of the Streaming Data Engine (SDE) via the Virtual Ethernet Application <https://github.com/aws/aws-fpga/tree/f2/sdk/apps/virtual-ethernet>`__
184194
-
185195
- `Design Spec <./hdk/cl/examples/cl-sde/README.html>`__
186196
* -
197+
-
187198
-
188199
-
189200
- `Design Source Code <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_sde/design>`__
190201
* -
202+
-
191203
-
192204
-
193205
- `Testbench <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_sde/verif>`__
194206
* -
207+
-
195208
-
196209
-
197210
- `Runtime Software <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_sde/software>`__
198211
* - Vitis
199212
- `hello_world <https://github.com/Xilinx/Vitis_Accel_Examples/tree/2024.1/hello_world>`__
213+
- Demonstrates streaming data to the FPGA via the XRT
200214
- `Guided Example <./vitis/README.html>`__
201215
- `Design Spec <https://github.com/Xilinx/Vitis_Accel_Examples/blob/main/hello_world/README.rst>`__
202216
* -
217+
-
203218
-
204219
-
205220
- `Design Source Code <https://github.com/Xilinx/Vitis_Accel_Examples/blob/main/hello_world/src/vadd.cpp>`__
206221
* -
222+
-
207223
-
208224
-
209225
- `Testbench <https://github.com/Xilinx/Vitis_Accel_Examples/blob/main/hello_world/src/host.cpp#L92>`__
210226
* -
227+
-
211228
-
212229
-
213230
- `Runtime Software <https://github.com/Xilinx/Vitis_Accel_Examples/blob/main/hello_world/src/host.cpp>`__

‎docs-rtd/source/_templates/layout.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{% extends "!layout.html" %}
22
{% block extrahead %}
33
{{ super() }}
4-
<meta name="google-site-verification" content="8Towr1qSHYbKJeNUM4gRR3T13Rbh895fJjuafp8Hc10" />
5-
{% endblock %}
4+
<meta name="google-site-verification" content="qIANNv1zFqrUiT3J8dIXZkUyaWrS_lLjtTk0tHTGRWw" />
5+
{% endblock %}

0 commit comments

Comments
 (0)