docs: getting_started: Clean up documentation

Signed-off-by: Jorge Marques <jorge.marques@analog.com>

Author: gastmaier

docs/conf.py

@@ -26,6 +26,10 @@
 
 # -- External docs configuration ----------------------------------------------
 
+interref_repos = [
+    'hdl',
+]
+
 intersphinx_mapping = {
     'upstream': ('https://docs.kernel.org', None),
     'b4': ('https://b4.docs.kernel.org/en/latest', None),

docs/getting_started.rst

@@ -6,31 +6,28 @@ Getting Started
 Description
 -----------
 
-The Linux kernel in this repository is the `Linux kernel from Xilinx
-<https://github.com/Xilinx/linux-xlnx>`__ together with drivers & patches
-applied from Analog Devices.
+The Linux kernel in this repository is the
+`Linux kernel from Xilinx <https://github.com/Xilinx/linux-xlnx>`__
+together with drivers & patches applied from Analog Devices.
 
 Details about the drivers that are of interest and supported by this repository
-can be found on the :dokuwiki:`Analog Devices wiki
-<resources/tools-software/linux-drivers-all>`. This readme focuses on details
-specific to how this code is structured/organized, how it was derived, etc.
-
-The current main is based on `xilinx v2024.1
-<https://github.com/Xilinx/linux-xlnx/tree/xilinx-v2024.1>`__. For details
-about the merge see commit :git-linux:`d31fa3135dbef8bf186a7c42fd87b3eedd8446e9
-<commit/d31fa3135dbef8bf186a7c42fd87b3eedd8446e9>` (Merge tag ``xilinx-v2024.1``
-of https://github.com/Xilinx/linux-xlnx.git). In this Xilinx release, the
-current version of upstream Linux is `Linux 6.6
-<https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tag/?h=v6.6>`__.
-
-For legacy reasons, the :git-linux:`xcomm_zynq:` is still available and should
-be in-sync with current master. That branch used to be the old master branch.
+can be found on the
+:dokuwiki:`Analog Devices wiki <resources/tools-software/linux-drivers-all>`.
+This readme focuses on details specific to how this code is
+structured/organized, how it was derived, etc.
+
+The current main is based on `xilinx v2025.1 <https://github.com/Xilinx/linux-xlnx/tree/xilinx-v2025.1>`__.
+For details about the merge see commit
+:git-linux:`3b1f15dc5c4d <commit/3b1f15dc5c4de92663059705d6f1cb6fc87d4470+>`
+(Merge tag ``xilinx-v2025.1`` of https://github.com/Xilinx/linux-xlnx.git).
+In this Xilinx release, the current version of upstream Linux is
+`Linux 6.12 <https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tag/?h=v6.12>`__.
 
 How to build
 ------------
 
-For build instructions :dokuwiki:`check the wiki
-<resources/tools-software/linux-drivers-all#building_the_adi_linux_kernel>`.
+For build instructions
+:dokuwiki:`check the wiki <resources/tools-software/linux-drivers-all#building_the_adi_linux_kernel>`.
 
 Release branches
 ----------------
@@ -39,14 +36,13 @@ All release branches have the ``[YEAR]_R[NUM]`` format. There are some special
 release branches sometimes (like ``2014_R2_altera``, because it wasn't always
 possible to match the Linux repo between Xilinx & Intel/Altera.
 
-Each release is matched with a release from the :git-hdl:`HDL repo <>`. The
+Each release is matched with a release from the :git-hdl:`HDL repo </>`. The
 branching name/model for the HDL repo differs a bit from the one in this repo,
 but the matching should be obvious. Therefore, each kernel in the release
 branches is be built using the toolchains from a specific version of Vivado &
-Quartus. A matching of these can be found :dokuwiki:`on the wiki
-<resources/fpga/docs/releases>`. Release branches can be built using other GCC
-toolchains, but in the official SD-card images provided, they will use the
-toolchains from Vivado/Quartus.
+Quartus. A matching of these can be found at :external+hdl:ref:`releases`.
+Release branches can be built using other GCC toolchains, but in the official
+SD-card images provided, they will use the toolchains from Vivado/Quartus.
 
 Rebased branches
 ----------------
@@ -55,12 +51,12 @@ Starting with :git-linux:`adi-4.9.0:` there are rebased branches. They're
 typically rebased branches from Xilinx with the ADI patches on top so that it's
 easier to identify patches that are not yet upstreamed.
 
-For :git-linux:`adi-4.9.0:` the base was branch `xlnx_rebase_v4.9
-<https://github.com/Xilinx/linux-xlnx/tree/xlnx_rebase_v4.9>`__ at commit
-:git-linux:`d45e196f59364e9f5eafe46027a7d2af349083974
-<commit/d45e196f59364e9f5eafe46027a7d2af349083974>` in the ADI repo and commit
-`45e196f59364e9f5eafe46027a7d2af349083974
-<https://github.com/Xilinx/linux-xlnx/commit/45e196f59364e9f5eafe46027a7d2af349083974>`__
+For :git-linux:`adi-4.9.0:` the base was branch
+`xlnx_rebase_v4.9 <https://github.com/Xilinx/linux-xlnx/tree/xlnx_rebase_v4.9>`__
+at commit
+:git-linux:`e5c22c2179cf <commit/e5c22c2179cfbec584d2c540d40a0c3d7a20770c+>`
+in the ADI repo and commit
+`45e196f59364 <https://github.com/Xilinx/linux-xlnx/commit/45e196f59364e9f5eafe46027a7d2af349083974>`__
 in the Xilinx repo. All ADI patches & drivers up to a specific point in time
 were cherry-picked to that branch from master. Note that since the
 ``adi-4.9.0`` branch is the first rebased branch, it's not particularly the
@@ -69,9 +65,8 @@ are somewhat reasonable to take and apply on top of an upstream 4.9 kernel
 after some polishing.
 
 The latest rebased branch depends on the current linux version supported in
-master. At the time of writing it is 5.10 so that :git-linux:`adi-5.10.0:` is
-the latest. Also note that a diff between the latest rebased branch and master
-(``git diff master adi-5.10.0``) must be NULL.
+master. Also note that a diff between the latest rebased branch and `xlnx-main`
+(e.g., ``git diff xlnx-main adi-6.12.0``) must be NULL.
 
 Raspberry Pi branches
 ---------------------
@@ -81,27 +76,25 @@ drivers present in the master branch should be automatically cherry-picked into
 the latest rpi branch.
 
 As in the rebased branches, the latest rpi branch should be in accordance with
-the current kernel version supported in master. At the time of writing, the
-kernel version in master is 5.10 so that the correspondent latest rpi branch is
-:git-linux:`rpi-5.10.y:`.
+the current kernel version supported in master.
 
 Intel/Altera branches
 ---------------------
 
 Because the kernel versions that Intel/Altera were usually not in sync with
 Xilinx's, ``altera-*`` branches were created:
 
-- :git-linux:`altera_4.0:`
-- :git-linux:`altera_4.4:`
-- :git-linux:`altera_4.6:`
-- :git-linux:`altera_4.9:`
+- :git-linux:`altera_4.0 <altera_4.0:>`
+- :git-linux:`altera_4.4 <altera_4.4:>`
+- :git-linux:`altera_4.6 <altera_4.6:>`
+- :git-linux:`altera_4.9 <altera_4.9:>`
+- :git-linux:`altera_4.14 <altera_4.14:>`
 
-These branches are derived from the `Intel/Altera linux kernel repo
-<https://github.com/altera-opensource/linux-socfpga>`__, together with some
-merged versions of old master branches.
+These branches are derived from the
+`Intel/Altera linux kernel repo <https://github.com/altera-opensource/linux-socfpga>`__,
+together with some merged versions of old master branches.
 
-The hope is that with the upcoming Linux 4.19, these branches would stop
-existing, since Intel/Altera seems to keep in sync their kernel version with
-more recent non-LTS kernels. Typically the releases/references that are
-provided for these boards should already be in the mainline kernel, so these
-branches should no longer be needed.
+These branches would stop existing, since Intel/Altera seems to keep in sync
+their kernel version with more recent non-LTS kernels. Typically the
+releases/references that are provided for these boards should already be in the
+mainline kernel, so these branches should no longer be needed.