doc: Move documents into subdirectories
authorPaul Beesley <paul.beesley@arm.com>
Mon, 11 Feb 2019 17:54:45 +0000 (17:54 +0000)
committerPaul Beesley <paul.beesley@arm.com>
Tue, 21 May 2019 14:05:56 +0000 (15:05 +0100)
commit40d553cfde38d4f68449c62967cd1ce0d6478750
tree1fafd4701066cdf0e5fb15aee2d842279a67b611
parent12b67439e93a78a4b756e987e1bd1b6e22cc4bf8
doc: Move documents into subdirectories

This change creates the following directories under docs/
in order to provide a grouping for the content:

- components
- design
- getting_started
- perf
- process

In each of these directories an index.rst file is created
and this serves as an index / landing page for each of the
groups when the pages are compiled. Proper layout of the
top-level table of contents relies on this directory/index
structure.

Without this patch it is possible to build the documents
correctly with Sphinx but the output looks messy because
there is no overall hierarchy.

Change-Id: I3c9f4443ec98571a56a6edf775f2c8d74d7f429f
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
95 files changed:
acknowledgements.rst [deleted file]
contributing.rst [deleted file]
docs/acknowledgements.rst [new file with mode: 0644]
docs/arm-sip-service.rst [deleted file]
docs/auth-framework.rst [deleted file]
docs/change-log.rst
docs/coding-guidelines.rst [deleted file]
docs/components/arm-sip-service.rst [new file with mode: 0644]
docs/components/exception-handling.rst [new file with mode: 0644]
docs/components/firmware-update.rst [new file with mode: 0644]
docs/components/index.rst [new file with mode: 0644]
docs/components/platform-interrupt-controller-API.rst [new file with mode: 0644]
docs/components/ras.rst [new file with mode: 0644]
docs/components/romlib-design.rst [new file with mode: 0644]
docs/components/sdei.rst [new file with mode: 0644]
docs/components/secure-partition-manager-design.rst [new file with mode: 0644]
docs/components/spd/index.rst [new file with mode: 0644]
docs/components/spd/optee-dispatcher.rst [new file with mode: 0644]
docs/components/spd/tlk-dispatcher.rst [new file with mode: 0644]
docs/components/spd/trusty-dispatcher.rst [new file with mode: 0644]
docs/components/xlat-tables-lib-v2-design.rst [new file with mode: 0644]
docs/contents.rst [deleted file]
docs/cpu-specific-build-macros.rst [deleted file]
docs/design/auth-framework.rst [new file with mode: 0644]
docs/design/cpu-specific-build-macros.rst [new file with mode: 0644]
docs/design/firmware-design.rst [new file with mode: 0644]
docs/design/index.rst [new file with mode: 0644]
docs/design/interrupt-framework-design.rst [new file with mode: 0644]
docs/design/psci-pd-tree.rst [new file with mode: 0644]
docs/design/reset-design.rst [new file with mode: 0644]
docs/design/trusted-board-boot.rst [new file with mode: 0644]
docs/exception-handling.rst [deleted file]
docs/firmware-design.rst [deleted file]
docs/firmware-update.rst [deleted file]
docs/frequently-asked-questions.rst [deleted file]
docs/getting_started/image-terminology.rst [new file with mode: 0644]
docs/getting_started/index.rst [new file with mode: 0644]
docs/getting_started/porting-guide.rst [new file with mode: 0644]
docs/getting_started/psci-lib-integration-guide.rst [new file with mode: 0644]
docs/getting_started/rt-svc-writers-guide.rst [new file with mode: 0644]
docs/getting_started/user-guide.rst [new file with mode: 0644]
docs/image-terminology.rst [deleted file]
docs/index.rst
docs/interrupt-framework-design.rst [deleted file]
docs/maintainers.rst [new file with mode: 0644]
docs/marvell/build.txt [deleted file]
docs/marvell/misc/mvebu-a8k-addr-map.txt [deleted file]
docs/marvell/misc/mvebu-amb.txt [deleted file]
docs/marvell/misc/mvebu-ccu.txt [deleted file]
docs/marvell/misc/mvebu-io-win.txt [deleted file]
docs/marvell/misc/mvebu-iob.txt [deleted file]
docs/marvell/porting.txt [deleted file]
docs/perf/index.rst [new file with mode: 0644]
docs/perf/psci-performance-juno.rst [new file with mode: 0644]
docs/plat/index.rst [new file with mode: 0644]
docs/plat/marvell/build.txt [new file with mode: 0644]
docs/plat/marvell/misc/mvebu-a8k-addr-map.txt [new file with mode: 0644]
docs/plat/marvell/misc/mvebu-amb.txt [new file with mode: 0644]
docs/plat/marvell/misc/mvebu-ccu.txt [new file with mode: 0644]
docs/plat/marvell/misc/mvebu-io-win.txt [new file with mode: 0644]
docs/plat/marvell/misc/mvebu-iob.txt [new file with mode: 0644]
docs/plat/marvell/porting.txt [new file with mode: 0644]
docs/plat/rpi3.rst
docs/platform-compatibility-policy.rst [deleted file]
docs/platform-interrupt-controller-API.rst [deleted file]
docs/porting-guide.rst [deleted file]
docs/process/coding-guidelines.rst [new file with mode: 0644]
docs/process/contributing.rst [new file with mode: 0644]
docs/process/faq.rst [new file with mode: 0644]
docs/process/index.rst [new file with mode: 0644]
docs/process/platform-compatibility-policy.rst [new file with mode: 0644]
docs/process/release-information.rst [new file with mode: 0644]
docs/process/security-center.rst [new file with mode: 0644]
docs/process/security-reporting.asc [new file with mode: 0644]
docs/psci-lib-integration-guide.rst [deleted file]
docs/psci-pd-tree.rst [deleted file]
docs/psci-performance-juno.rst [deleted file]
docs/ras.rst [deleted file]
docs/readme.rst [new file with mode: 0644]
docs/release-information.rst [deleted file]
docs/reset-design.rst [deleted file]
docs/romlib-design.rst [deleted file]
docs/rt-svc-writers-guide.rst [deleted file]
docs/sdei.rst [deleted file]
docs/secure-partition-manager-design.rst [deleted file]
docs/security-center.rst [deleted file]
docs/security-reporting.asc [deleted file]
docs/security_advisories/index.rst [new file with mode: 0644]
docs/spd/optee-dispatcher.rst [deleted file]
docs/spd/tlk-dispatcher.rst [deleted file]
docs/spd/trusty-dispatcher.rst [deleted file]
docs/trusted-board-boot.rst [deleted file]
docs/user-guide.rst [deleted file]
docs/xlat-tables-lib-v2-design.rst [deleted file]
maintainers.rst [deleted file]