From 347609510e30f5cc3f33beaad3cf085e8296b883 Mon Sep 17 00:00:00 2001 From: Paul Beesley Date: Fri, 12 Apr 2019 14:19:42 +0100 Subject: doc: Convert internal links to RST format Currently links between documents are using the format: .rst This was required for services like GitHub because they render each document in isolation - linking to another document is like linking to any other file, just provide the full path. However, with the new approach, the .rst files are only the raw source for the documents. Once the documents have been rendered the output is now in another format (HTML in our case) and so, when linking to another document, the link must point to the rendered version and not the .rst file. The RST spec provides a few methods for linking between content. The parent of this patch enabled the automatic creation of anchors for document titles - we will use these anchors as the targets for our links. Additional anchors can be added by hand if needed, on section and sub-section titles, for example. An example of this new format, for a document with the title "Firmware Design" is :ref:`Firmware Design`. One big advantage of this is that anchors are not dependent on paths. We can then move documents around, even between directories, without breaking any links between documents. Links will need to be updated only if the title of a document changes. Change-Id: I9e2340a61dd424cbd8fd1ecc2dc166f460d81703 Signed-off-by: Paul Beesley --- docs/components/exception-handling.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'docs/components/exception-handling.rst') diff --git a/docs/components/exception-handling.rst b/docs/components/exception-handling.rst index 0d017331..3f386854 100644 --- a/docs/components/exception-handling.rst +++ b/docs/components/exception-handling.rst @@ -26,8 +26,8 @@ Introduction Through various control bits in the ``SCR_EL3`` register, the Arm architecture allows for asynchronous exceptions to be routed to EL3. As described in the -`Interrupt Framework Design`_ document, depending on the chosen interrupt -routing model, TF-A appropriately sets the ``FIQ`` and ``IRQ`` bits of +:ref:`Interrupt Management Framework` document, depending on the chosen +interrupt routing model, TF-A appropriately sets the ``FIQ`` and ``IRQ`` bits of ``SCR_EL3`` register to effect this routing. For most use cases, other than for the purpose of facilitating context switch between Normal and Secure worlds, FIQs and IRQs routed to EL3 are not required to be handled in EL3. @@ -143,8 +143,9 @@ Interrupt handling ------------------ The |EHF| is a client of *Interrupt Management Framework*, and registers the -top-level handler for interrupts that target EL3, as described in the `Interrupt -Framework Design`_ document. This has the following implications. +top-level handler for interrupts that target EL3, as described in the +:ref:`Interrupt Management Framework` document. This has the following +implications: - On GICv3 systems, when executing in S-EL1, pending Non-secure interrupts of sufficient priority are signalled as FIQs, and therefore will be routed to @@ -618,9 +619,8 @@ The |EHF| has the following limitations: exception descriptor and the programmed priority of interrupts handled by the dispatcher match. The |EHF| cannot verify that this has been followed. ----- +-------------- -*Copyright (c) 2018, Arm Limited and Contributors. All rights reserved.* +*Copyright (c) 2018-2019, Arm Limited and Contributors. All rights reserved.* -.. _Interrupt Framework Design: ../design/interrupt-framework-design.rst .. _SDEI specification: http://infocenter.arm.com/help/topic/com.arm.doc.den0054a/ARM_DEN0054A_Software_Delegated_Exception_Interface.pdf -- cgit v1.2.3