Commit 67d9ef7d authored by Peter Maydell's avatar Peter Maydell
Browse files

Merge remote-tracking branch 'remotes/pmaydell/tags/pull-docs-20200312' into staging 



docs queue:
 * Remove some no longer needed texinfo infrastructure
 * Reorder the top level index docs to put most useful manuals first
 * Split the Arm target-specific info into sub-pages
 * Improve the Arm documentation a bit with info previously
   only on the wiki page

# gpg: Signature made Thu 12 Mar 2020 11:42:10 GMT
# gpg:                using RSA key E1A5C593CD419DE28E8315CF3C2525ED14360CDE
# gpg:                issuer "peter.maydell@linaro.org"
# gpg: Good signature from "Peter Maydell <peter.maydell@linaro.org>" [ultimate]
# gpg:                 aka "Peter Maydell <pmaydell@gmail.com>" [ultimate]
# gpg:                 aka "Peter Maydell <pmaydell@chiark.greenend.org.uk>" [ultimate]
# Primary key fingerprint: E1A5 C593 CD41 9DE2 8E83  15CF 3C25 25ED 1436 0CDE

* remotes/pmaydell/tags/pull-docs-20200312:
  docs: Be consistent about capitalization of 'Arm'
  docs: Move arm-cpu-features.rst into the system manual
  docs/system/target-arm.rst: Add some introductory text
  docs/system: Split target-arm.rst into sub-documents
  Makefile: Allow for subdirectories in Sphinx manual dependencies
  docs/qemu-option-trace.rst.inc: Remove redundant comment
  docs/index.rst, docs/index.html.in: Reorder manuals
  Makefile: Make all Sphinx documentation depend on the extensions
  docs/sphinx/hxtool.py: Remove STEXI/ETEXI support
  hxtool: Remove Texinfo generation support
  Update comments in .hx files that mention Texinfo
  Makefile: Remove redundant Texinfo related code

Signed-off-by: default avatarPeter Maydell <peter.maydell@linaro.org>
parents 474acbe0 6fe6d6c9

MAINTAINERS

+9 −0
Original line number Diff line number Diff line
@@ -155,6 +155,7 @@ F: include/hw/cpu/a*mpcore.h 
F: disas/arm.c

F: disas/arm-a64.cc

F: disas/libvixl/

F: docs/system/target-arm.rst



ARM SMMU

M: Eric Auger <eric.auger@redhat.com>
@@ -615,6 +616,7 @@ F: hw/arm/integratorcp.c 
F: hw/misc/arm_integrator_debug.c

F: include/hw/misc/arm_integrator_debug.h

F: tests/acceptance/machine_arm_integratorcp.py

F: docs/system/arm/integratorcp.rst



MCIMX6UL EVK / i.MX6ul

M: Peter Maydell <peter.maydell@linaro.org>
@@ -673,6 +675,7 @@ M: Peter Maydell <peter.maydell@linaro.org> 
L: qemu-arm@nongnu.org

S: Odd Fixes

F: hw/arm/musicpal.c

F: docs/system/arm/musicpal.rst



nSeries

M: Andrzej Zaborowski <balrogg@gmail.com>
@@ -689,6 +692,7 @@ F: include/hw/display/blizzard.h 
F: include/hw/input/tsc2xxx.h

F: include/hw/misc/cbus.h

F: tests/acceptance/machine_arm_n8x0.py

F: docs/system/arm/nseries.rst



Palm

M: Andrzej Zaborowski <balrogg@gmail.com>
@@ -698,6 +702,7 @@ S: Odd Fixes 
F: hw/arm/palm.c

F: hw/input/tsc210x.c

F: include/hw/input/tsc2xxx.h

F: docs/system/arm/palm.rst



Raspberry Pi

M: Peter Maydell <peter.maydell@linaro.org>
@@ -719,6 +724,7 @@ F: hw/arm/realview* 
F: hw/cpu/realview_mpcore.c

F: hw/intc/realview_gic.c

F: include/hw/intc/realview_gic.h

F: docs/system/arm/realview.rst



PXA2XX

M: Andrzej Zaborowski <balrogg@gmail.com>
@@ -738,6 +744,7 @@ F: hw/misc/max111x.c 
F: include/hw/arm/pxa.h

F: include/hw/arm/sharpsl.h

F: include/hw/display/tc6393xb.h

F: docs/system/arm/xscale.rst



SABRELITE / i.MX6

M: Peter Maydell <peter.maydell@linaro.org>
@@ -773,6 +780,7 @@ L: qemu-arm@nongnu.org 
S: Maintained

F: hw/*/stellaris*

F: include/hw/input/gamepad.h

F: docs/system/arm/stellaris.rst



Versatile Express

M: Peter Maydell <peter.maydell@linaro.org>
@@ -786,6 +794,7 @@ L: qemu-arm@nongnu.org 
S: Maintained

F: hw/*/versatile*

F: hw/misc/arm_sysctl.c

F: docs/system/arm/versatile.rst



Virt

M: Peter Maydell <peter.maydell@linaro.org>

Makefile

+4 −12
Original line number Diff line number Diff line
@@ -795,7 +795,7 @@ rm -f $(MANUAL_BUILDDIR)/$1/objects.inv $(MANUAL_BUILDDIR)/$1/searchindex.js $(M 
endef



distclean: clean

	rm -f config-host.mak config-host.h* config-host.ld $(DOCS) qemu-options.texi qemu-monitor.texi qemu-monitor-info.texi

	rm -f config-host.mak config-host.h* config-host.ld $(DOCS)

	rm -f tests/tcg/config-*.mak

	rm -f config-all-devices.mak config-all-disas.mak config.status

	rm -f $(SUBDIR_DEVICES_MAK)
@@ -1078,9 +1078,10 @@ sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \ 
# a single doctree: https://github.com/sphinx-doc/sphinx/issues/2946

build-manual = $(call quiet-command,CONFDIR="$(qemu_confdir)" $(SPHINX_BUILD) $(if $(V),,-q) -W -b $2 -D version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$1")

# We assume all RST files in the manual's directory are used in it

manual-deps = $(wildcard $(SRC_PATH)/docs/$1/*.rst) \

manual-deps = $(wildcard $(SRC_PATH)/docs/$1/*.rst $(SRC_PATH)/docs/$1/*/*.rst) \

              $(SRC_PATH)/docs/defs.rst.inc \

              $(SRC_PATH)/docs/$1/conf.py $(SRC_PATH)/docs/conf.py

              $(SRC_PATH)/docs/$1/conf.py $(SRC_PATH)/docs/conf.py \

              $(SRC_PATH)/docs/sphinx/*.py

# Macro to write out the rule and dependencies for building manpages

# Usage: $(call define-manpage-rule,manualname,manpage1 manpage2...[,extradeps])

# 'extradeps' is optional, and specifies extra files (eg .hx files) that
@@ -1122,15 +1123,6 @@ $(MANUAL_BUILDDIR)/index.html: $(SRC_PATH)/docs/index.html.in qemu-version.h 
	$(call quiet-command, sed "s|@@VERSION@@|${VERSION}|g" $< >$@, \

             "GEN","$@")



qemu-options.texi: $(SRC_PATH)/qemu-options.hx $(SRC_PATH)/scripts/hxtool

	$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@")



qemu-monitor.texi: $(SRC_PATH)/hmp-commands.hx $(SRC_PATH)/scripts/hxtool

	$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@")



qemu-monitor-info.texi: $(SRC_PATH)/hmp-commands-info.hx $(SRC_PATH)/scripts/hxtool

	$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@")



docs/interop/qemu-qmp-qapi.texi: qapi/qapi-doc.texi

	@cp -p $< $@

docs/can.txt

+1 −1
Original line number Diff line number Diff line
@@ -13,7 +13,7 @@ controller is implemented. 


The PCI addon card hardware has been selected as the first CAN

interface to implement because such device can be easily connected

to systems with different CPU architectures (x86, PowerPC, ARM, etc.).

to systems with different CPU architectures (x86, PowerPC, Arm, etc.).



The project has been initially started in frame of RTEMS GSoC 2013

slot by Jin Yang under our mentoring  The initial idea was to provide generic

docs/devel/atomics.txt

+1 −1
Original line number Diff line number Diff line
@@ -87,7 +87,7 @@ Sequentially consistent loads and stores can be done using: 
    atomic_xchg(ptr, val) for stores



However, they are quite expensive on some platforms, notably POWER and

ARM.  Therefore, qemu/atomic.h provides two primitives with slightly

Arm.  Therefore, qemu/atomic.h provides two primitives with slightly

weaker constraints:



    typeof(*ptr) atomic_mb_read(ptr)

docs/devel/kconfig.rst

+1 −1
Original line number Diff line number Diff line
@@ -8,7 +8,7 @@ time different targets can share large amounts of code. For example, 
a POWER and an x86 board can run the same code to emulate a PCI network

card, even though the boards use different PCI host bridges, and they

can run the same code to emulate a SCSI disk while using different

SCSI adapters.  ARM, s390 and x86 boards can all present a virtio-blk

SCSI adapters.  Arm, s390 and x86 boards can all present a virtio-blk

disk to their guests, but with three different virtio guest interfaces.



Each QEMU target enables a subset of the boards, devices and buses that