Skip to content

Commit 55aef1d

Browse files
Replace other master branch references to main
* README.md * adi_regmap_xcvr.txt * build_hdl.rst * hdl_coding_guideline.rst * data_offload/README.md Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
1 parent e7c12d4 commit 55aef1d

File tree

5 files changed

+21
-19
lines changed

5 files changed

+21
-19
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ There is no free replacement for consulting services. If you have questions that
4343

4444
## Getting started
4545

46-
This repository supports reference designs for different [Analog Devices boards](../master/projects) based on [Intel and Xilinx FPGA development boards](../master/projects/common) or standalone.
46+
This repository supports reference designs for different [Analog Devices boards](../main/projects) based on [Intel and Xilinx FPGA development boards](../main/projects/common) or standalone.
4747

4848
### Building documentation
4949

@@ -95,12 +95,14 @@ more information.
9595

9696
* If you want to use the most stable code base, always use the [latest release branch](https://github.com/analogdevicesinc/hdl/releases).
9797

98-
* If you want to use the greatest and latest, check out the [master branch](https://github.com/analogdevicesinc/hdl/tree/master).
98+
* If you want to use the greatest and latest, check out the [main branch](https://github.com/analogdevicesinc/hdl/tree/main).
9999

100100
## Use already built files
101101

102-
You can download already built files and use them as they are. They are available on [this link]( https://swdownloads.analog.com/cse/hdl_builds/master/latest_boot_partition.tar.gz).
103-
The files are built from [master branch](https://github.com/analogdevicesinc/hdl/tree/master) whenever there are new commits in HDL or Linux repositories.
102+
You can download already built files and use them as they are.
103+
For the main branch, they are available at the link inside [this document](https://swdownloads.analog.com/cse/boot_partition_files/main/latest_boot.txt). Keep in mind that the ones from the main branch are not stable all the time.
104+
We suggest using the latest release branch [2022_r2, here](https://swdownloads.analog.com/cse/boot_partition_files/2022_r2/latest_boot.txt).
105+
The files are built from [main branch](https://github.com/analogdevicesinc/hdl/tree/main) whenever there are new commits in HDL or Linux repositories.
104106

105107
> :warning: Pay attention when using already built files, since they are not tested in HW!
106108
@@ -114,14 +116,14 @@ terms.
114116
The user should read each of these license terms, and understand the
115117
freedoms and responsibilities that he or she has by using this source/core.
116118

117-
See [LICENSE](../master/LICENSE) for more details. The separate license files
119+
See [LICENSE](../main/LICENSE) for more details. The separate license files
118120
cab be found here:
119121

120-
* [LICENSE_ADIBSD](../master/LICENSE_ADIBSD)
122+
* [LICENSE_ADIBSD](../main/LICENSE_ADIBSD)
121123

122-
* [LICENSE_GPL2](../master/LICENSE_GPL2)
124+
* [LICENSE_GPL2](../main/LICENSE_GPL2)
123125

124-
* [LICENSE_LGPL](../master/LICENSE_LGPL)
126+
* [LICENSE_LGPL](../main/LICENSE_LGPL)
125127

126128
## Comprehensive user guide
127129

docs/regmap/adi_regmap_xcvr.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ ENDFIELD
110110
REG
111111
0x0007
112112
FPGA_INFO
113-
FPGA device information [[https://github.com/analogdevicesinc/hdl/blob/master/library/scripts/adi_xilinx_device_info_enc.tcl |Xilinx encoded values]]
113+
FPGA device information [[https://github.com/analogdevicesinc/hdl/blob/main/library/scripts/adi_xilinx_device_info_enc.tcl |Xilinx encoded values]]
114114
ENDREG
115115

116116
FIELD
@@ -198,7 +198,7 @@ FIELD
198198
[19:16]
199199
XCVR_TYPE[3:0]
200200
RO
201-
[[https://github.com/analogdevicesinc/hdl/blob/master/library/scripts/adi_xilinx_device_info_enc.tcl | Xilinx encoded values.]]
201+
[[https://github.com/analogdevicesinc/hdl/blob/main/library/scripts/adi_xilinx_device_info_enc.tcl | Xilinx encoded values.]]
202202
ENDFIELD
203203

204204
FIELD

docs/user_guide/build_hdl.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ HDL project from the repository:
3131
- Starting with ``hdl_2021_r1`` release branch:
3232
:git-hdl:`scripts/adi_env.tcl`
3333
- For ``hdl_2019_r2`` and older:
34-
:git-hdl:`hdl/projects/scripts/adi_project_xilinx.tcl <projects/scripts/adi_project_xilinx.tcl>` for Vivado, and
35-
:git-hdl:`hdl/projects/scripts/adi_project_intel.tcl <projects/scripts/adi_project_intel.tcl>` for Quartus.
34+
:git-hdl:`hdl/projects/scripts/adi_project_xilinx.tcl <hdl_2019_r2:projects/scripts/adi_project_xilinx.tcl>` for Vivado, and
35+
:git-hdl:`hdl/projects/scripts/adi_project_intel.tcl <hdl_2019_r2:projects/scripts/adi_project_intel.tcl>` for Quartus.
3636

3737
#. Download the tools from the following links:
3838

@@ -95,7 +95,7 @@ Setup the HDL repository
9595
-------------------------------------------------------------------------------
9696
These designs are built upon ADI's generic HDL reference designs framework.
9797
ADI does not distribute the bit/elf files of these projects so they
98-
must be built from the sources available :git-hdl:`here <master:/>`. To get
98+
must be built from the sources available :git-hdl:`here </>`. To get
9999
the source you must
100100
`clone <https://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository>`__
101101
the repository. This is the best method to get the sources. Here, we are
@@ -668,10 +668,10 @@ to use an unsupported version of tools.
668668
The easiest way is to check the `release
669669
notes <https://github.com/analogdevicesinc/hdl/releases>`__. You may
670670
also check out or browse the desired branch, and verify the tool version
671-
in the base Tcl script
672-
(`./hdl/projects/scripts/adi_project_xilinx.tcl <https://github.com/analogdevicesinc/hdl/blob/master/projects/scripts/adi_project_xilinx.tcl#L4>`__)
671+
in the base Tcl script ./hdl/scripts/adi_env.tcl
672+
(:git-hdl:`for Vivado version <scripts/adi_env.tcl#L18>`)
673673
or
674-
(`./hdl/projects/scripts/adi_project_intel.tcl <https://github.com/analogdevicesinc/hdl/blob/master/projects/scripts/adi_project_intel.tcl#L5>`__),
674+
(:git-hdl:`or for Quartus version <scripts/adi_env.tcl#L34>`),
675675
which build the projects.
676676

677677
Environment

docs/user_guide/hdl_coding_guideline.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -686,7 +686,7 @@ Annex 1 Verilog file format
686686
//
687687
// 2. An ADI specific BSD license, which can be found in the top level directory
688688
// of this repository (LICENSE_ADIBSD), and also on-line at:
689-
// https://github.com/analogdevicesinc/hdl/blob/master/LICENSE_ADIBSD
689+
// https://github.com/analogdevicesinc/hdl/blob/main/LICENSE_ADIBSD
690690
// This will allow to generate bit files and not release the source code,
691691
// as long as it attaches to an ADI device.
692692
//
@@ -783,7 +783,7 @@ Annex 2 VHDL file format
783783
--
784784
-- 2. An ADI specific BSD license, which can be found in the top level directory
785785
-- of this repository (LICENSE_ADIBSD), and also on-line at:
786-
-- https://github.com/analogdevicesinc/hdl/blob/master/LICENSE_ADIBSD
786+
-- https://github.com/analogdevicesinc/hdl/blob/main/LICENSE_ADIBSD
787787
-- This will allow to generate bit files and not release the source code,
788788
-- as long as it attaches to an ADI device.
789789
--

library/data_offload/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ A general frequency relationship of the above clocks are:
256256
CLKdma <= CLKddr <= CLKconverter
257257
```
258258

259-
The clock domain crossing should be handled by the [util_axis_fifo](https://github.com/analogdevicesinc/hdl/tree/master/library/util_axis_fifo) module.
259+
The clock domain crossing should be handled by the [util_axis_fifo](https://github.com/analogdevicesinc/hdl/tree/main/library/util_axis_fifo) module.
260260
* **TODO** : Make sure that we support both AXIS and FIFO
261261
* **TODO** : Add support for asymmetric aspect ratio.
262262

0 commit comments

Comments
 (0)