1. 27 Jan, 2020 2 commits
  2. 22 Jan, 2020 2 commits
  3. 22 Oct, 2019 10 commits
  4. 21 Oct, 2019 5 commits
    • laurenw-arm's avatar
      Update change log for v2.2 Release · 77caea29
      laurenw-arm authored
      Signed-off-by: default avatarLauren Wehrmeister <lauren.wehrmeister@arm.com>
      Change-Id: I53a7706016539e7de7fdbe87b786d99665bbe1d8
    • Paul Beesley's avatar
      doc: Move platform list to the Platform Ports index page · 5e6b4163
      Paul Beesley authored
      The list of upstream platforms on the index page is growing
      quite long, especially with all the FVP variants being listed
      This patch leverages the "Platform Ports" chapter in the docs
      table of contents to condense this information. Almost all
      platform ports now have documentation, so the table of
      contents serves as the list of upstream platforms by itself.
      For those upstream platforms that do not have corresponding
      documentation, the top-level "Platform Ports" page mentions
      them individually. It also mentions each Arm FVP, just as
      the index page did before.
      Note that there is an in-progress patch that creates new
      platform port documentation for the Arm Juno and Arm FVP
      platforms, so this list of "other platforms" will soon be
      reduced further as those platforms become part of the
      table of contents as well.
      Change-Id: I6b1eab8cba71a599d85a6e22553a34b07f213268
      Signed-off-by: default avatarPaul Beesley <paul.beesley@arm.com>
    • Paul Beesley's avatar
      doc: Move "About" content from index.rst to a new chapter · 8eb9490b
      Paul Beesley authored
      The index.rst page is now the primary landing page for the TF-A
      documentation. It contains quite a lot of content these days,
      - The project purpose and general intro
      - A list of functionality
      - A list of planned functionality
      - A list of supported platforms
      - "Getting started" links to other documents
      - Contact information for raising issues
      This patch creates an "About" chapter in the table
      of contents and moves some content there. In order,
      the above listed content:
      - Stayed where it is. This is the right place for it.
      - Moved to About->Features
      - Moved to About->Features (in subsection)
      - Stayed where it is. Moved in a later patch.
      - Was expanded in-place
      - Moved to About->Contact
      Change-Id: I254bb87560fd09140b9e485cf15246892aa45943
      Signed-off-by: default avatarPaul Beesley <paul.beesley@arm.com>
    • Soby Mathew's avatar
    • Soby Mathew's avatar
  5. 18 Oct, 2019 3 commits
  6. 17 Oct, 2019 1 commit
    • Paul Beesley's avatar
      doc: Remove version and release variables from conf.py · 206c077b
      Paul Beesley authored
      We would need to update this version for the release but, in fact,
      it is not required for our publishing workflow; the hosted version
      of the docs uses git commit/tag information in place of these
      variables anyway.
      Instead of updating the version, just remove these variables
      Change-Id: I424c4e45786e87604e91c7197b7983579afe4806
      Signed-off-by: default avatarPaul Beesley <paul.beesley@arm.com>
  7. 15 Oct, 2019 5 commits
  8. 11 Oct, 2019 3 commits
  9. 09 Oct, 2019 4 commits
    • Paul Beesley's avatar
    • Paul Beesley's avatar
      doc: Formatting fixes for readme.rst · 76cf653b
      Paul Beesley authored
      The readme.rst file in the project root is the front-page that
      is displayed on Github and if viewing the TF-A repository on
      git.trustedfirmware.org in the "about" view. It now contains a
      small amount of stub content, and directs readers to the
      ReadTheDocs documentation via trustedfirmware.org/docs/tf-a.
      The Github renderer is displaying the content fine but the cgit
      viewer displays some "backlink" errors because some content
      substitutions were left in place (terms surrounded by pipe
      symbols), e.g. |TF-A|.
      This patch removes those substitutions, that are not supported
      by cgit, and also updates one heading to clarify where to find
      the new docs.
      Change-Id: I358451df45b8c99975ba0b6db8ea61253a10560d
      Signed-off-by: default avatarPaul Beesley <paul.beesley@arm.com>
    • Paul Beesley's avatar
      Merge changes from topic "pb/readthedocs" into integration · f8e3340c
      Paul Beesley authored
      * changes:
        doc: Add guide for building the docs locally
        doc: De-duplicate readme and license files
        doc: Convert internal links to RST format
    • Paul Beesley's avatar
      doc: Add guide for building the docs locally · 862c764a
      Paul Beesley authored
      This new page contains instructions for doing a local
      build of the documentation, plus information on the environment
      setup that needs to be done beforehand.
      Change-Id: If563145ab40639cabbe25d0f62759981a33692c6
      Signed-off-by: default avatarPaul Beesley <paul.beesley@arm.com>
  10. 08 Oct, 2019 5 commits
    • Paul Beesley's avatar
      doc: De-duplicate readme and license files · 8cc36aec
      Paul Beesley authored
      The readme.rst and license.rst files in the project root overlap
      with the index.rst and license.rst files in the docs/ folder. We
      need to use the latter when building the documentation, as Sphinx
      requires all included files to be under a common root. However,
      the files in the root are currently used by the cgit and Github
      Using symlinks in Git presents some difficulties so the best
      course of action is likely to leave these files but in stub form.
      The license.rst file in the root will simply tell the reader to
      refer to docs/license.rst.
      The readme.rst file will contain a small amount of content that
      is derived from the docs/index.rst file, so that the Github main
      page will have something valid to show, but it will also contain
      a link to the full documentation on ReadTheDocs.
      Change-Id: I6dc46f08777e8d7ecb32ca7afc07a28486c9f77a
      Signed-off-by: default avatarPaul Beesley <paul.beesley@arm.com>
    • Paul Beesley's avatar
      doc: Convert internal links to RST format · 34760951
      Paul Beesley authored
      Currently links between documents are using the format:
      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: default avatarPaul Beesley <paul.beesley@arm.com>
    • Soby Mathew's avatar
    • Soby Mathew's avatar
    • Avinash Mehta's avatar
      Correct UART PL011 initialization calculation · 38d5e150
      Avinash Mehta authored
      Currently for Armv7 plaforms the quotient calculated in pl011
      uart init code is moved to register r1.
      This patch moves the quotient to register r2 as done for other
      platforms in the udiv instruction. Value of register r2 is then
      used to calculate the values for IBRD and FBRD register
      Change-Id: Ie6622f9f0e6d634378b471df5d02823b492c8a24
      Signed-off-by: default avatarAvinash Mehta <avinash.mehta@arm.com>