The goal on this series is to not let ReST documents orphaned.
It moves files that are already on ReST format to a better place,
when needed, and add them to the documentation body.
On my past attempt, I was too "aggressive" trying to move all files
under Documentation/*.txt to some place. It ends that I did some
mistakes, so, on this series, I opted to do the reverse: I only moved
files that seemed to obviously belong to some place.
So, after this patch series, there will still 44 orphaned document
files under Documentation/*.txt, to be addressed on a next Kernel
version.
After this series, there will be "only" 386 files with the .txt extension:
$ find Documentation/ -name '*.txt'|grep -v features/|grep -v devicetree|grep -v output|wc -l
386
(I'm excluding features, as those aren't really a text file, but a sort
of textual database)
The end result of this patch series (plus the other ones I sent today)
is at:
https://www.infradead.org/~mchehab/rst_conversion/
And the full documentation patch series at:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=convert_rst_renames_v7.1
Mauro Carvalho Chehab (39):
docs: thermal: add it to the driver API
docs: rapidio: add it to the driver API
docs: perf: move to the admin-guide
docs: nvdimm: add it to the driver-api book
docs: namespace: move it to the admin-guide
docs: mtd: move it to the driver-api book
docs: nfc: add it to the driver-api book
docs: mmc: move it to the driver-api
docs: md: move it to the driver-api book
docs: leds: add it to the driver-api book
docs: ioctl: add it to the uAPI guide
docs: interconnect.rst: add it to the driver-api guide
docs: add arch doc directories to the index
docs: device-mapper: move it to the admin-guide
docs: early-userspace: move to driver-api guide
docs: admin-guide: move sysctl directory to it
docs: admin-guide: add laptops documentation
docs: admin-guide: add kdump documentation into it
docs: blockdev: add it to the admin-guide
docs: security: move some books to it and update
docs: x86: move two x86-specific files to x86 arch dir
docs: ocxl.rst: add it to the uAPI book
docs: lp855x-driver.rst: add it to the driver-api book
docs: driver-model: move it to the driver-api book
docs: add some documentation dirs to the driver-api book
docs: aoe: add it to the driver-api book
docs: cgroup-v1: add it to the admin-guide book
docs: admin-guide: add a series of orphaned documents
docs: driver-api: add a series of orphaned documents
docs: driver-api: add xilinx driver API documentation
docs: driver-api: add remaining converted dirs to it
docs: serial: move it to the driver-api
docs: phy: place documentation under driver-api
docs: add a memory-devices subdir to driver-api
docs: infiniband: add it to the driver-api bookset
docs: add SPDX tags to new index files
docs: adds some directories to the main documentation index
docs: locking: add it to the main index
docs: gpio: add sysfs interface to the admin-guide
CREDITS | 2 +-
Documentation/ABI/obsolete/sysfs-gpio | 2 +-
Documentation/ABI/removed/sysfs-class-rfkill | 2 +-
Documentation/ABI/stable/sysfs-class-rfkill | 2 +-
Documentation/ABI/stable/sysfs-devices-node | 2 +-
Documentation/ABI/testing/procfs-diskstats | 2 +-
Documentation/ABI/testing/sysfs-block | 2 +-
Documentation/ABI/testing/sysfs-block-device | 2 +-
.../ABI/testing/sysfs-class-switchtec | 2 +-
.../ABI/testing/sysfs-devices-system-cpu | 4 +-
.../ABI/testing/sysfs-platform-asus-laptop | 2 +-
Documentation/accounting/index.rst | 2 +-
Documentation/{ => admin-guide}/aoe/aoe.rst | 4 +-
.../{ => admin-guide}/aoe/autoload.sh | 0
.../{ => admin-guide}/aoe/examples.rst | 0
Documentation/{ => admin-guide}/aoe/index.rst | 2 -
Documentation/{ => admin-guide}/aoe/status.sh | 0
Documentation/{ => admin-guide}/aoe/todo.rst | 0
.../{ => admin-guide}/aoe/udev-install.sh | 0
Documentation/{ => admin-guide}/aoe/udev.txt | 2 +-
.../blockdev/drbd/DRBD-8.3-data-packets.svg | 0
.../blockdev/drbd/DRBD-data-packets.svg | 0
.../blockdev/drbd/conn-states-8.dot | 0
.../blockdev/drbd/data-structure-v9.rst | 0
.../blockdev/drbd/disk-states-8.dot | 0
.../drbd/drbd-connection-state-overview.dot | 0
.../blockdev/drbd/figures.rst | 2 +
.../{ => admin-guide}/blockdev/drbd/index.rst | 0
.../blockdev/drbd/node-states-8.dot | 1 -
.../{ => admin-guide}/blockdev/floppy.rst | 0
.../{ => admin-guide}/blockdev/index.rst | 2 +-
.../{ => admin-guide}/blockdev/nbd.rst | 0
.../{ => admin-guide}/blockdev/paride.rst | 0
.../{ => admin-guide}/blockdev/ramdisk.rst | 0
.../{ => admin-guide}/blockdev/zram.rst | 0
.../{btmrvl.txt => admin-guide/btmrvl.rst} | 0
Documentation/admin-guide/bug-hunting.rst | 4 +-
.../cgroup-v1/blkio-controller.rst | 0
.../{ => admin-guide}/cgroup-v1/cgroups.rst | 4 +-
.../{ => admin-guide}/cgroup-v1/cpuacct.rst | 0
.../{ => admin-guide}/cgroup-v1/cpusets.rst | 2 +-
.../{ => admin-guide}/cgroup-v1/devices.rst | 0
.../cgroup-v1/freezer-subsystem.rst | 0
.../{ => admin-guide}/cgroup-v1/hugetlb.rst | 0
.../{ => admin-guide}/cgroup-v1/index.rst | 2 -
.../cgroup-v1/memcg_test.rst | 4 +-
.../{ => admin-guide}/cgroup-v1/memory.rst | 0
.../{ => admin-guide}/cgroup-v1/net_cls.rst | 0
.../{ => admin-guide}/cgroup-v1/net_prio.rst | 0
.../{ => admin-guide}/cgroup-v1/pids.rst | 0
.../{ => admin-guide}/cgroup-v1/rdma.rst | 0
Documentation/admin-guide/cgroup-v2.rst | 2 +-
.../clearing-warn-once.rst} | 0
.../cpu-load.rst} | 0
.../cputopology.rst} | 0
.../device-mapper/cache-policies.rst | 0
.../{ => admin-guide}/device-mapper/cache.rst | 0
.../{ => admin-guide}/device-mapper/delay.rst | 0
.../device-mapper/dm-crypt.rst | 0
.../device-mapper/dm-dust.txt | 0
.../device-mapper/dm-flakey.rst | 0
.../device-mapper/dm-init.rst | 0
.../device-mapper/dm-integrity.rst | 0
.../{ => admin-guide}/device-mapper/dm-io.rst | 0
.../device-mapper/dm-log.rst | 0
.../device-mapper/dm-queue-length.rst | 0
.../device-mapper/dm-raid.rst | 0
.../device-mapper/dm-service-time.rst | 0
.../device-mapper/dm-uevent.rst | 0
.../device-mapper/dm-zoned.rst | 0
.../{ => admin-guide}/device-mapper/era.rst | 0
.../{ => admin-guide}/device-mapper/index.rst | 2 -
.../device-mapper/kcopyd.rst | 0
.../device-mapper/linear.rst | 0
.../device-mapper/log-writes.rst | 0
.../device-mapper/persistent-data.rst | 0
.../device-mapper/snapshot.rst | 0
.../device-mapper/statistics.rst | 4 +-
.../device-mapper/striped.rst | 0
.../device-mapper/switch.rst | 0
.../device-mapper/thin-provisioning.rst | 0
.../device-mapper/unstriped.rst | 0
.../device-mapper/verity.rst | 0
.../device-mapper/writecache.rst | 0
.../{ => admin-guide}/device-mapper/zero.rst | 0
.../efi-stub.rst} | 0
.../{ => admin-guide}/gpio/index.rst | 2 +-
.../{ => admin-guide}/gpio/sysfs.rst | 0
.../{highuid.txt => admin-guide/highuid.rst} | 0
Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +-
.../hw_random.rst} | 0
Documentation/admin-guide/index.rst | 28 +++++++
.../{iostats.txt => admin-guide/iostats.rst} | 0
.../{ => admin-guide}/kdump/gdbmacros.txt | 0
.../{ => admin-guide}/kdump/index.rst | 1 -
.../{ => admin-guide}/kdump/kdump.rst | 0
.../{ => admin-guide}/kdump/vmcoreinfo.rst | 0
.../admin-guide/kernel-parameters.txt | 36 ++++----
.../kernel-per-CPU-kthreads.rst} | 2 +-
.../{ => admin-guide}/laptops/asus-laptop.rst | 0
.../laptops/disk-shock-protection.rst | 0
.../{ => admin-guide}/laptops/index.rst | 2 +-
.../{ => admin-guide}/laptops/laptop-mode.rst | 0
.../{ => admin-guide}/laptops/lg-laptop.rst | 1 -
.../{ => admin-guide}/laptops/sony-laptop.rst | 0
.../{ => admin-guide}/laptops/sonypi.rst | 0
.../laptops/thinkpad-acpi.rst | 6 +-
.../laptops/toshiba_haps.rst | 0
.../lcd-panel-cgram.rst | 2 -
.../{ldm.txt => admin-guide/ldm.rst} | 0
.../lockup-watchdogs.rst} | 0
.../mm/cma_debugfs.rst} | 2 -
Documentation/admin-guide/mm/index.rst | 3 +-
Documentation/admin-guide/mm/ksm.rst | 2 +-
.../admin-guide/mm/numa_memory_policy.rst | 2 +-
.../namespaces/compatibility-list.rst | 0
.../{ => admin-guide}/namespaces/index.rst | 2 +-
.../namespaces/resource-control.rst | 0
.../numastat.rst} | 0
.../{ => admin-guide}/perf/arm-ccn.rst | 0
.../{ => admin-guide}/perf/arm_dsu_pmu.rst | 0
.../{ => admin-guide}/perf/hisi-pmu.rst | 0
.../{ => admin-guide}/perf/index.rst | 2 +-
.../{ => admin-guide}/perf/qcom_l2_pmu.rst | 0
.../{ => admin-guide}/perf/qcom_l3_pmu.rst | 0
.../{ => admin-guide}/perf/thunderx2-pmu.rst | 0
.../{ => admin-guide}/perf/xgene-pmu.rst | 0
.../{pnp.txt => admin-guide/pnp.rst} | 0
.../{driver-api => admin-guide}/rapidio.rst | 0
.../{rtc.txt => admin-guide/rtc.rst} | 0
.../{svga.txt => admin-guide/svga.rst} | 0
.../{ => admin-guide}/sysctl/abi.rst | 0
Documentation/{ => admin-guide}/sysctl/fs.rst | 0
.../{ => admin-guide}/sysctl/index.rst | 2 -
.../{ => admin-guide}/sysctl/kernel.rst | 2 +-
.../{ => admin-guide}/sysctl/net.rst | 0
.../{ => admin-guide}/sysctl/sunrpc.rst | 0
.../{ => admin-guide}/sysctl/user.rst | 0
Documentation/{ => admin-guide}/sysctl/vm.rst | 4 +-
.../video-output.rst} | 0
Documentation/arm/index.rst | 2 +-
Documentation/arm/nwfpe/index.rst | 2 +
Documentation/arm/omap/index.rst | 2 +
Documentation/arm/sa1100/index.rst | 2 +
Documentation/arm/samsung-s3c24xx/index.rst | 2 +
Documentation/arm/samsung/index.rst | 2 +
Documentation/arm64/index.rst | 2 -
Documentation/block/bfq-iosched.rst | 2 +-
Documentation/block/index.rst | 2 +-
Documentation/cdrom/index.rst | 2 +-
Documentation/core-api/printk-formats.rst | 2 +-
.../devicetree/bindings/phy/phy-bindings.txt | 2 +-
.../devicetree/bindings/phy/phy-pxa-usb.txt | 2 +-
.../backlight/lp855x-driver.rst | 2 -
.../bt8xxgpio.rst} | 0
.../{connector => driver-api}/connector.rst | 2 +-
.../{console => driver-api}/console.rst | 2 +-
.../{dcdbas.txt => driver-api/dcdbas.rst} | 0
.../{dell_rbu.txt => driver-api/dell_rbu.rst} | 0
.../{ => driver-api}/driver-model/binding.rst | 0
.../{ => driver-api}/driver-model/bus.rst | 0
.../{ => driver-api}/driver-model/class.rst | 0
.../driver-model/design-patterns.rst | 0
.../{ => driver-api}/driver-model/device.rst | 0
.../{ => driver-api}/driver-model/devres.rst | 0
.../{ => driver-api}/driver-model/driver.rst | 0
.../{ => driver-api}/driver-model/index.rst | 2 -
.../driver-model/overview.rst | 0
.../driver-model/platform.rst | 0
.../{ => driver-api}/driver-model/porting.rst | 2 +-
.../early-userspace/buffer-format.rst | 0
.../early_userspace_support.rst | 0
.../early-userspace/index.rst | 2 +-
.../{EDID/howto.rst => driver-api/edid.rst} | 2 +-
.../{eisa.txt => driver-api/eisa.rst} | 4 +-
Documentation/driver-api/gpio/driver.rst | 2 +-
Documentation/driver-api/index.rst | 44 +++++++++-
.../interconnect.rst | 2 -
Documentation/{isa.txt => driver-api/isa.rst} | 0
.../{isapnp.txt => driver-api/isapnp.rst} | 0
.../pblk.txt => driver-api/lightnvm-pblk.rst} | 0
Documentation/{ => driver-api}/md/index.rst | 2 +-
.../{ => driver-api}/md/md-cluster.rst | 0
.../{ => driver-api}/md/raid5-cache.rst | 0
.../{ => driver-api}/md/raid5-ppl.rst | 0
.../driver-api/memory-devices/index.rst | 18 ++++
.../memory-devices/ti-emif.rst | 2 +-
.../memory-devices}/ti-gpmc.rst | 2 +-
.../men-chameleon-bus.rst} | 0
Documentation/{ => driver-api}/mmc/index.rst | 2 +-
.../{ => driver-api}/mmc/mmc-async-req.rst | 0
.../{ => driver-api}/mmc/mmc-dev-attrs.rst | 0
.../{ => driver-api}/mmc/mmc-dev-parts.rst | 0
.../{ => driver-api}/mmc/mmc-tools.rst | 0
Documentation/{ => driver-api}/mtd/index.rst | 2 +-
.../{ => driver-api}/mtd/intel-spi.rst | 0
.../{ => driver-api}/mtd/nand_ecc.rst | 0
.../{ => driver-api}/mtd/spi-nor.rst | 0
Documentation/{ => driver-api}/nfc/index.rst | 2 +-
.../{ => driver-api}/nfc/nfc-hci.rst | 0
.../{ => driver-api}/nfc/nfc-pn544.rst | 0
Documentation/{ntb.txt => driver-api/ntb.rst} | 0
Documentation/{ => driver-api}/nvdimm/btt.rst | 0
.../{ => driver-api}/nvdimm/index.rst | 2 +-
.../{ => driver-api}/nvdimm/nvdimm.rst | 0
.../{ => driver-api}/nvdimm/security.rst | 0
Documentation/{nvmem => driver-api}/nvmem.rst | 2 +-
.../parport-lowlevel.rst} | 0
Documentation/driver-api/phy/index.rst | 18 ++++
.../{phy.txt => driver-api/phy/phy.rst} | 0
.../{ => driver-api}/phy/samsung-usb2.rst | 2 -
Documentation/driver-api/pps.rst | 2 +-
.../{pti => driver-api}/pti_intel_mid.rst | 2 +-
Documentation/driver-api/ptp.rst | 2 +-
Documentation/{pwm.txt => driver-api/pwm.rst} | 0
.../{ => driver-api}/rapidio/index.rst | 2 +-
.../{ => driver-api}/rapidio/mport_cdev.rst | 0
.../{ => driver-api}/rapidio/rapidio.rst | 0
.../{ => driver-api}/rapidio/rio_cm.rst | 0
.../{ => driver-api}/rapidio/sysfs.rst | 0
.../{ => driver-api}/rapidio/tsi721.rst | 0
.../{rfkill.txt => driver-api/rfkill.rst} | 0
.../{ => driver-api}/serial/cyclades_z.rst | 0
.../{ => driver-api}/serial/driver.rst | 2 +-
.../{ => driver-api}/serial/index.rst | 2 +-
.../{ => driver-api}/serial/moxa-smartio.rst | 0
.../{ => driver-api}/serial/n_gsm.rst | 0
.../{ => driver-api}/serial/rocket.rst | 0
.../serial/serial-iso7816.rst | 0
.../{ => driver-api}/serial/serial-rs485.rst | 0
Documentation/{ => driver-api}/serial/tty.rst | 0
.../{sgi-ioc4.txt => driver-api/sgi-ioc4.rst} | 0
.../{SM501.txt => driver-api/sm501.rst} | 0
.../smsc_ece1099.rst} | 0
.../switchtec.rst} | 2 +-
.../sync_file.rst} | 0
.../thermal/cpu-cooling-api.rst | 0
.../thermal/exynos_thermal.rst | 0
.../thermal/exynos_thermal_emulation.rst | 0
.../{ => driver-api}/thermal/index.rst | 2 +-
.../thermal/intel_powerclamp.rst | 0
.../thermal/nouveau_thermal.rst | 0
.../thermal/power_allocator.rst | 0
.../{ => driver-api}/thermal/sysfs-api.rst | 12 +--
.../thermal/x86_pkg_temperature_thermal.rst | 2 +-
.../vfio-mediated-device.rst} | 2 +-
.../{vfio.txt => driver-api/vfio.rst} | 0
.../{ => driver-api}/xilinx/eemi.rst | 0
.../{ => driver-api}/xilinx/index.rst | 1 -
.../{xillybus.txt => driver-api/xillybus.rst} | 0
.../{zorro.txt => driver-api/zorro.rst} | 0
Documentation/fault-injection/index.rst | 2 +-
Documentation/fb/fbcon.rst | 4 +-
Documentation/fb/index.rst | 2 +-
Documentation/fb/vesafb.rst | 2 +-
Documentation/filesystems/nfs/nfsroot.txt | 2 +-
Documentation/filesystems/proc.txt | 2 +-
.../filesystems/ramfs-rootfs-initramfs.txt | 4 +-
Documentation/filesystems/sysfs.txt | 2 +-
Documentation/filesystems/tmpfs.txt | 2 +-
.../firmware-guide/acpi/enumeration.rst | 2 +-
Documentation/fpga/index.rst | 2 +-
Documentation/hid/index.rst | 2 +-
Documentation/hwmon/submitting-patches.rst | 2 +-
Documentation/ia64/index.rst | 2 +-
Documentation/ide/index.rst | 2 +-
Documentation/iio/index.rst | 2 +-
Documentation/index.rst | 34 ++++++++
Documentation/infiniband/index.rst | 2 +-
Documentation/ioctl/index.rst | 2 +-
Documentation/ioctl/ioctl-number.rst | 2 -
Documentation/kbuild/index.rst | 2 +-
Documentation/leds/index.rst | 2 +-
Documentation/livepatch/index.rst | 2 +-
Documentation/locking/index.rst | 2 +-
Documentation/m68k/index.rst | 2 +-
Documentation/mic/index.rst | 2 -
Documentation/netlabel/index.rst | 2 +-
Documentation/networking/ip-sysctl.txt | 2 +-
Documentation/pcmcia/index.rst | 2 +-
Documentation/power/index.rst | 2 +-
.../powerpc/firmware-assisted-dump.rst | 2 +-
Documentation/powerpc/index.rst | 2 +-
Documentation/riscv/index.rst | 2 -
Documentation/s390/index.rst | 2 -
Documentation/s390/vfio-ccw.rst | 6 +-
Documentation/scheduler/index.rst | 2 -
Documentation/scheduler/sched-deadline.rst | 2 +-
Documentation/scheduler/sched-design-CFS.rst | 2 +-
Documentation/scheduler/sched-rt-group.rst | 2 +-
Documentation/security/index.rst | 5 +-
.../security/{LSM.rst => lsm-development.rst} | 0
Documentation/{lsm.txt => security/lsm.rst} | 0
Documentation/{SAK.txt => security/sak.rst} | 0
.../{siphash.txt => security/siphash.rst} | 0
Documentation/security/tpm/index.rst | 1 +
Documentation/security/tpm/xen-tpmfront.rst | 2 -
Documentation/sparc/index.rst | 2 -
Documentation/target/index.rst | 2 +-
Documentation/timers/index.rst | 2 +-
.../translations/zh_CN/filesystems/sysfs.txt | 2 +-
Documentation/translations/zh_CN/gpio.txt | 4 +-
.../translations/zh_CN/oops-tracing.txt | 4 +-
.../{ => userspace-api}/accelerators/ocxl.rst | 2 -
Documentation/userspace-api/index.rst | 1 +
Documentation/vm/numa.rst | 4 +-
Documentation/vm/page_migration.rst | 2 +-
Documentation/vm/unevictable-lru.rst | 4 +-
Documentation/w1/w1.netlink | 2 +-
Documentation/watchdog/hpwdt.rst | 2 +-
Documentation/watchdog/index.rst | 2 +-
Documentation/x86/index.rst | 2 +
.../{Intel-IOMMU.txt => x86/intel-iommu.rst} | 0
.../{intel_txt.txt => x86/intel_txt.rst} | 0
Documentation/x86/topology.rst | 2 +-
.../x86/x86_64/fake-numa-for-cpusets.rst | 4 +-
Documentation/xtensa/index.rst | 2 +-
MAINTAINERS | 82 +++++++++----------
Next/merge.log | 4 +-
arch/arm/Kconfig | 4 +-
arch/arm64/Kconfig | 2 +-
arch/parisc/Kconfig | 2 +-
arch/sh/Kconfig | 4 +-
arch/sparc/Kconfig | 2 +-
arch/x86/Kconfig | 8 +-
block/Kconfig | 2 +-
block/partitions/Kconfig | 2 +-
drivers/base/platform.c | 2 +-
drivers/block/Kconfig | 8 +-
drivers/block/floppy.c | 2 +-
drivers/block/zram/Kconfig | 6 +-
drivers/char/Kconfig | 6 +-
drivers/char/hw_random/core.c | 2 +-
drivers/dma-buf/Kconfig | 2 +-
drivers/gpio/Kconfig | 2 +-
drivers/gpio/gpio-cs5535.c | 2 +-
drivers/gpu/drm/Kconfig | 2 +-
drivers/md/Kconfig | 2 +-
drivers/md/dm-init.c | 2 +-
drivers/md/dm-raid.c | 2 +-
drivers/mtd/nand/raw/nand_ecc.c | 2 +-
drivers/net/ethernet/intel/ice/ice_main.c | 2 +-
drivers/nvdimm/Kconfig | 2 +-
drivers/pci/switch/Kconfig | 2 +-
drivers/perf/qcom_l3_pmu.c | 2 +-
drivers/platform/x86/Kconfig | 8 +-
drivers/platform/x86/dcdbas.c | 2 +-
drivers/platform/x86/dell_rbu.c | 2 +-
drivers/pnp/isapnp/Kconfig | 2 +-
drivers/rapidio/Kconfig | 2 +-
.../staging/unisys/Documentation/overview.txt | 4 +-
drivers/tty/Kconfig | 6 +-
drivers/tty/serial/ucc_uart.c | 2 +-
drivers/vfio/Kconfig | 2 +-
drivers/vfio/mdev/Kconfig | 2 +-
drivers/w1/Kconfig | 2 +-
fs/proc/Kconfig | 2 +-
include/linux/cgroup-defs.h | 2 +-
include/linux/device.h | 2 +-
include/linux/hw_random.h | 2 +-
include/linux/platform_device.h | 2 +-
include/linux/serial_core.h | 2 +-
include/linux/thermal.h | 4 +-
include/uapi/linux/bpf.h | 2 +-
init/Kconfig | 4 +-
kernel/cgroup/cpuset.c | 2 +-
kernel/panic.c | 2 +-
mm/swap.c | 2 +-
samples/Kconfig | 2 +-
scripts/coccinelle/free/devm_free.cocci | 2 +-
security/Kconfig | 2 +-
security/device_cgroup.c | 2 +-
tools/include/uapi/linux/bpf.h | 2 +-
tools/testing/selftests/zram/README | 2 +-
usr/Kconfig | 2 +-
375 files changed, 436 insertions(+), 318 deletions(-)
rename Documentation/{ => admin-guide}/aoe/aoe.rst (97%)
rename Documentation/{ => admin-guide}/aoe/autoload.sh (100%)
rename Documentation/{ => admin-guide}/aoe/examples.rst (100%)
rename Documentation/{ => admin-guide}/aoe/index.rst (95%)
rename Documentation/{ => admin-guide}/aoe/status.sh (100%)
rename Documentation/{ => admin-guide}/aoe/todo.rst (100%)
rename Documentation/{ => admin-guide}/aoe/udev-install.sh (100%)
rename Documentation/{ => admin-guide}/aoe/udev.txt (93%)
rename Documentation/{ => admin-guide}/blockdev/drbd/DRBD-8.3-data-packets.svg (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/DRBD-data-packets.svg (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/conn-states-8.dot (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/data-structure-v9.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/disk-states-8.dot (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/drbd-connection-state-overview.dot (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/figures.rst (95%)
rename Documentation/{ => admin-guide}/blockdev/drbd/index.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/node-states-8.dot (99%)
rename Documentation/{ => admin-guide}/blockdev/floppy.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/index.rst (83%)
rename Documentation/{ => admin-guide}/blockdev/nbd.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/paride.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/ramdisk.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/zram.rst (100%)
rename Documentation/{btmrvl.txt => admin-guide/btmrvl.rst} (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/blkio-controller.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/cgroups.rst (99%)
rename Documentation/{ => admin-guide}/cgroup-v1/cpuacct.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/cpusets.rst (99%)
rename Documentation/{ => admin-guide}/cgroup-v1/devices.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/freezer-subsystem.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/hugetlb.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/index.rst (97%)
rename Documentation/{ => admin-guide}/cgroup-v1/memcg_test.rst (98%)
rename Documentation/{ => admin-guide}/cgroup-v1/memory.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/net_cls.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/net_prio.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/pids.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/rdma.rst (100%)
rename Documentation/{clearing-warn-once.txt => admin-guide/clearing-warn-once.rst} (100%)
rename Documentation/{cpu-load.txt => admin-guide/cpu-load.rst} (100%)
rename Documentation/{cputopology.txt => admin-guide/cputopology.rst} (100%)
rename Documentation/{ => admin-guide}/device-mapper/cache-policies.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/cache.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/delay.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-crypt.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-dust.txt (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-flakey.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-init.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-integrity.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-io.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-log.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-queue-length.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-raid.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-service-time.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-uevent.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-zoned.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/era.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/index.rst (98%)
rename Documentation/{ => admin-guide}/device-mapper/kcopyd.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/linear.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/log-writes.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/persistent-data.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/snapshot.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/statistics.rst (98%)
rename Documentation/{ => admin-guide}/device-mapper/striped.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/switch.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/thin-provisioning.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/unstriped.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/verity.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/writecache.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/zero.rst (100%)
rename Documentation/{efi-stub.txt => admin-guide/efi-stub.rst} (100%)
rename Documentation/{ => admin-guide}/gpio/index.rst (78%)
rename Documentation/{ => admin-guide}/gpio/sysfs.rst (100%)
rename Documentation/{highuid.txt => admin-guide/highuid.rst} (100%)
rename Documentation/{hw_random.txt => admin-guide/hw_random.rst} (100%)
rename Documentation/{iostats.txt => admin-guide/iostats.rst} (100%)
rename Documentation/{ => admin-guide}/kdump/gdbmacros.txt (100%)
rename Documentation/{ => admin-guide}/kdump/index.rst (97%)
rename Documentation/{ => admin-guide}/kdump/kdump.rst (100%)
rename Documentation/{ => admin-guide}/kdump/vmcoreinfo.rst (100%)
rename Documentation/{kernel-per-CPU-kthreads.txt => admin-guide/kernel-per-CPU-kthreads.rst} (99%)
rename Documentation/{ => admin-guide}/laptops/asus-laptop.rst (100%)
rename Documentation/{ => admin-guide}/laptops/disk-shock-protection.rst (100%)
rename Documentation/{ => admin-guide}/laptops/index.rst (84%)
rename Documentation/{ => admin-guide}/laptops/laptop-mode.rst (100%)
rename Documentation/{ => admin-guide}/laptops/lg-laptop.rst (99%)
rename Documentation/{ => admin-guide}/laptops/sony-laptop.rst (100%)
rename Documentation/{ => admin-guide}/laptops/sonypi.rst (100%)
rename Documentation/{ => admin-guide}/laptops/thinkpad-acpi.rst (99%)
rename Documentation/{ => admin-guide}/laptops/toshiba_haps.rst (100%)
rename Documentation/{auxdisplay => admin-guide}/lcd-panel-cgram.rst (99%)
rename Documentation/{ldm.txt => admin-guide/ldm.rst} (100%)
rename Documentation/{lockup-watchdogs.txt => admin-guide/lockup-watchdogs.rst} (100%)
rename Documentation/{cma/debugfs.rst => admin-guide/mm/cma_debugfs.rst} (98%)
rename Documentation/{ => admin-guide}/namespaces/compatibility-list.rst (100%)
rename Documentation/{ => admin-guide}/namespaces/index.rst (74%)
rename Documentation/{ => admin-guide}/namespaces/resource-control.rst (100%)
rename Documentation/{numastat.txt => admin-guide/numastat.rst} (100%)
rename Documentation/{ => admin-guide}/perf/arm-ccn.rst (100%)
rename Documentation/{ => admin-guide}/perf/arm_dsu_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/hisi-pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/index.rst (85%)
rename Documentation/{ => admin-guide}/perf/qcom_l2_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/qcom_l3_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/thunderx2-pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/xgene-pmu.rst (100%)
rename Documentation/{pnp.txt => admin-guide/pnp.rst} (100%)
rename Documentation/{driver-api => admin-guide}/rapidio.rst (100%)
rename Documentation/{rtc.txt => admin-guide/rtc.rst} (100%)
rename Documentation/{svga.txt => admin-guide/svga.rst} (100%)
rename Documentation/{ => admin-guide}/sysctl/abi.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/fs.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/index.rst (99%)
rename Documentation/{ => admin-guide}/sysctl/kernel.rst (99%)
rename Documentation/{ => admin-guide}/sysctl/net.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/sunrpc.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/user.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/vm.rst (99%)
rename Documentation/{video-output.txt => admin-guide/video-output.rst} (100%)
rename Documentation/{ => driver-api}/backlight/lp855x-driver.rst (99%)
rename Documentation/{bt8xxgpio.txt => driver-api/bt8xxgpio.rst} (100%)
rename Documentation/{connector => driver-api}/connector.rst (99%)
rename Documentation/{console => driver-api}/console.rst (99%)
rename Documentation/{dcdbas.txt => driver-api/dcdbas.rst} (100%)
rename Documentation/{dell_rbu.txt => driver-api/dell_rbu.rst} (100%)
rename Documentation/{ => driver-api}/driver-model/binding.rst (100%)
rename Documentation/{ => driver-api}/driver-model/bus.rst (100%)
rename Documentation/{ => driver-api}/driver-model/class.rst (100%)
rename Documentation/{ => driver-api}/driver-model/design-patterns.rst (100%)
rename Documentation/{ => driver-api}/driver-model/device.rst (100%)
rename Documentation/{ => driver-api}/driver-model/devres.rst (100%)
rename Documentation/{ => driver-api}/driver-model/driver.rst (100%)
rename Documentation/{ => driver-api}/driver-model/index.rst (96%)
rename Documentation/{ => driver-api}/driver-model/overview.rst (100%)
rename Documentation/{ => driver-api}/driver-model/platform.rst (100%)
rename Documentation/{ => driver-api}/driver-model/porting.rst (99%)
rename Documentation/{ => driver-api}/early-userspace/buffer-format.rst (100%)
rename Documentation/{ => driver-api}/early-userspace/early_userspace_support.rst (100%)
rename Documentation/{ => driver-api}/early-userspace/index.rst (85%)
rename Documentation/{EDID/howto.rst => driver-api/edid.rst} (98%)
rename Documentation/{eisa.txt => driver-api/eisa.rst} (98%)
rename Documentation/{interconnect => driver-api}/interconnect.rst (99%)
rename Documentation/{isa.txt => driver-api/isa.rst} (100%)
rename Documentation/{isapnp.txt => driver-api/isapnp.rst} (100%)
rename Documentation/{lightnvm/pblk.txt => driver-api/lightnvm-pblk.rst} (100%)
rename Documentation/{ => driver-api}/md/index.rst (71%)
rename Documentation/{ => driver-api}/md/md-cluster.rst (100%)
rename Documentation/{ => driver-api}/md/raid5-cache.rst (100%)
rename Documentation/{ => driver-api}/md/raid5-ppl.rst (100%)
create mode 100644 Documentation/driver-api/memory-devices/index.rst
rename Documentation/{ => driver-api}/memory-devices/ti-emif.rst (98%)
rename Documentation/{bus-devices => driver-api/memory-devices}/ti-gpmc.rst (99%)
rename Documentation/{men-chameleon-bus.txt => driver-api/men-chameleon-bus.rst} (100%)
rename Documentation/{ => driver-api}/mmc/index.rst (82%)
rename Documentation/{ => driver-api}/mmc/mmc-async-req.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-dev-attrs.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-dev-parts.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-tools.rst (100%)
rename Documentation/{ => driver-api}/mtd/index.rst (81%)
rename Documentation/{ => driver-api}/mtd/intel-spi.rst (100%)
rename Documentation/{ => driver-api}/mtd/nand_ecc.rst (100%)
rename Documentation/{ => driver-api}/mtd/spi-nor.rst (100%)
rename Documentation/{ => driver-api}/nfc/index.rst (78%)
rename Documentation/{ => driver-api}/nfc/nfc-hci.rst (100%)
rename Documentation/{ => driver-api}/nfc/nfc-pn544.rst (100%)
rename Documentation/{ntb.txt => driver-api/ntb.rst} (100%)
rename Documentation/{ => driver-api}/nvdimm/btt.rst (100%)
rename Documentation/{ => driver-api}/nvdimm/index.rst (82%)
rename Documentation/{ => driver-api}/nvdimm/nvdimm.rst (100%)
rename Documentation/{ => driver-api}/nvdimm/security.rst (100%)
rename Documentation/{nvmem => driver-api}/nvmem.rst (99%)
rename Documentation/{parport-lowlevel.txt => driver-api/parport-lowlevel.rst} (100%)
create mode 100644 Documentation/driver-api/phy/index.rst
rename Documentation/{phy.txt => driver-api/phy/phy.rst} (100%)
rename Documentation/{ => driver-api}/phy/samsung-usb2.rst (99%)
rename Documentation/{pti => driver-api}/pti_intel_mid.rst (99%)
rename Documentation/{pwm.txt => driver-api/pwm.rst} (100%)
rename Documentation/{ => driver-api}/rapidio/index.rst (82%)
rename Documentation/{ => driver-api}/rapidio/mport_cdev.rst (100%)
rename Documentation/{ => driver-api}/rapidio/rapidio.rst (100%)
rename Documentation/{ => driver-api}/rapidio/rio_cm.rst (100%)
rename Documentation/{ => driver-api}/rapidio/sysfs.rst (100%)
rename Documentation/{ => driver-api}/rapidio/tsi721.rst (100%)
rename Documentation/{rfkill.txt => driver-api/rfkill.rst} (100%)
rename Documentation/{ => driver-api}/serial/cyclades_z.rst (100%)
rename Documentation/{ => driver-api}/serial/driver.rst (99%)
rename Documentation/{ => driver-api}/serial/index.rst (90%)
rename Documentation/{ => driver-api}/serial/moxa-smartio.rst (100%)
rename Documentation/{ => driver-api}/serial/n_gsm.rst (100%)
rename Documentation/{ => driver-api}/serial/rocket.rst (100%)
rename Documentation/{ => driver-api}/serial/serial-iso7816.rst (100%)
rename Documentation/{ => driver-api}/serial/serial-rs485.rst (100%)
rename Documentation/{ => driver-api}/serial/tty.rst (100%)
rename Documentation/{sgi-ioc4.txt => driver-api/sgi-ioc4.rst} (100%)
rename Documentation/{SM501.txt => driver-api/sm501.rst} (100%)
rename Documentation/{smsc_ece1099.txt => driver-api/smsc_ece1099.rst} (100%)
rename Documentation/{switchtec.txt => driver-api/switchtec.rst} (97%)
rename Documentation/{sync_file.txt => driver-api/sync_file.rst} (100%)
rename Documentation/{ => driver-api}/thermal/cpu-cooling-api.rst (100%)
rename Documentation/{ => driver-api}/thermal/exynos_thermal.rst (100%)
rename Documentation/{ => driver-api}/thermal/exynos_thermal_emulation.rst (100%)
rename Documentation/{ => driver-api}/thermal/index.rst (86%)
rename Documentation/{ => driver-api}/thermal/intel_powerclamp.rst (100%)
rename Documentation/{ => driver-api}/thermal/nouveau_thermal.rst (100%)
rename Documentation/{ => driver-api}/thermal/power_allocator.rst (100%)
rename Documentation/{ => driver-api}/thermal/sysfs-api.rst (98%)
rename Documentation/{ => driver-api}/thermal/x86_pkg_temperature_thermal.rst (94%)
rename Documentation/{vfio-mediated-device.txt => driver-api/vfio-mediated-device.rst} (99%)
rename Documentation/{vfio.txt => driver-api/vfio.rst} (100%)
rename Documentation/{ => driver-api}/xilinx/eemi.rst (100%)
rename Documentation/{ => driver-api}/xilinx/index.rst (94%)
rename Documentation/{xillybus.txt => driver-api/xillybus.rst} (100%)
rename Documentation/{zorro.txt => driver-api/zorro.rst} (100%)
rename Documentation/security/{LSM.rst => lsm-development.rst} (100%)
rename Documentation/{lsm.txt => security/lsm.rst} (100%)
rename Documentation/{SAK.txt => security/sak.rst} (100%)
rename Documentation/{siphash.txt => security/siphash.rst} (100%)
rename Documentation/{ => userspace-api}/accelerators/ocxl.rst (99%)
rename Documentation/{Intel-IOMMU.txt => x86/intel-iommu.rst} (100%)
rename Documentation/{intel_txt.txt => x86/intel_txt.rst} (100%)
--
2.21.0
This subsystem-specific documentation belongs to the
driver-api.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
.../devicetree/bindings/phy/phy-bindings.txt | 2 +-
.../devicetree/bindings/phy/phy-pxa-usb.txt | 2 +-
Documentation/driver-api/index.rst | 1 +
Documentation/driver-api/phy/index.rst | 16 ++++++++++++++++
.../{phy.txt => driver-api/phy/phy.rst} | 0
.../{ => driver-api}/phy/samsung-usb2.rst | 0
Documentation/index.rst | 1 -
MAINTAINERS | 2 +-
8 files changed, 20 insertions(+), 4 deletions(-)
create mode 100644 Documentation/driver-api/phy/index.rst
rename Documentation/{phy.txt => driver-api/phy/phy.rst} (100%)
rename Documentation/{ => driver-api}/phy/samsung-usb2.rst (100%)
diff --git a/Documentation/devicetree/bindings/phy/phy-bindings.txt b/Documentation/devicetree/bindings/phy/phy-bindings.txt
index a403b81d0679..c4eb38902533 100644
--- a/Documentation/devicetree/bindings/phy/phy-bindings.txt
+++ b/Documentation/devicetree/bindings/phy/phy-bindings.txt
@@ -1,5 +1,5 @@
This document explains only the device tree data binding. For general
-information about PHY subsystem refer to Documentation/phy.txt
+information about PHY subsystem refer to Documentation/driver-api/phy/phy.rst
PHY device node
===============
diff --git a/Documentation/devicetree/bindings/phy/phy-pxa-usb.txt b/Documentation/devicetree/bindings/phy/phy-pxa-usb.txt
index 93fc09c12954..d80e36a77ec5 100644
--- a/Documentation/devicetree/bindings/phy/phy-pxa-usb.txt
+++ b/Documentation/devicetree/bindings/phy/phy-pxa-usb.txt
@@ -15,4 +15,4 @@ Example:
};
This document explains the device tree binding. For general
-information about PHY subsystem refer to Documentation/phy.txt
+information about PHY subsystem refer to Documentation/driver-api/phy/phy.rst
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index d6f532c8d824..12d68c3ab792 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -85,6 +85,7 @@ available subsections can be seen below.
parport-lowlevel
pps
ptp
+ phy/index
pti_intel_mid
pwm
rfkill
diff --git a/Documentation/driver-api/phy/index.rst b/Documentation/driver-api/phy/index.rst
new file mode 100644
index 000000000000..fce9ffae2812
--- /dev/null
+++ b/Documentation/driver-api/phy/index.rst
@@ -0,0 +1,16 @@
+=====================
+Generic PHY Framework
+=====================
+
+.. toctree::
+
+ phy
+ samsung-usb2
+
+.. only:: subproject and html
+
+ Indices
+ =======
+
+ * :ref:`genindex`
+
diff --git a/Documentation/phy.txt b/Documentation/driver-api/phy/phy.rst
similarity index 100%
rename from Documentation/phy.txt
rename to Documentation/driver-api/phy/phy.rst
diff --git a/Documentation/phy/samsung-usb2.rst b/Documentation/driver-api/phy/samsung-usb2.rst
similarity index 100%
rename from Documentation/phy/samsung-usb2.rst
rename to Documentation/driver-api/phy/samsung-usb2.rst
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 28e6b5ef17b4..ea33cbbccd9d 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -112,7 +112,6 @@ needed).
usb/index
misc-devices/index
mic/index
- phy/samsung-usb2
scheduler/index
Architecture-specific documentation
diff --git a/MAINTAINERS b/MAINTAINERS
index 856db8015edd..cda68bbd9d1c 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -14031,7 +14031,7 @@ M: Sylwester Nawrocki <[email protected]>
L: [email protected]
S: Supported
F: Documentation/devicetree/bindings/phy/samsung-phy.txt
-F: Documentation/phy/samsung-usb2.rst
+F: Documentation/driver-api/phy/samsung-usb2.rst
F: drivers/phy/samsung/phy-exynos4210-usb2.c
F: drivers/phy/samsung/phy-exynos4x12-usb2.c
F: drivers/phy/samsung/phy-exynos5250-usb2.c
--
2.21.0
The perf infrastructure is used for userspace to track issues.
At least a good part of what's described here is related to
it.
So, add it to the admin-guide.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/admin-guide/index.rst | 1 +
Documentation/{ => admin-guide}/perf/arm-ccn.rst | 0
Documentation/{ => admin-guide}/perf/arm_dsu_pmu.rst | 0
Documentation/{ => admin-guide}/perf/hisi-pmu.rst | 0
Documentation/{ => admin-guide}/perf/index.rst | 2 --
Documentation/{ => admin-guide}/perf/qcom_l2_pmu.rst | 0
Documentation/{ => admin-guide}/perf/qcom_l3_pmu.rst | 0
Documentation/{ => admin-guide}/perf/thunderx2-pmu.rst | 0
Documentation/{ => admin-guide}/perf/xgene-pmu.rst | 0
MAINTAINERS | 4 ++--
drivers/perf/qcom_l3_pmu.c | 2 +-
11 files changed, 4 insertions(+), 5 deletions(-)
rename Documentation/{ => admin-guide}/perf/arm-ccn.rst (100%)
rename Documentation/{ => admin-guide}/perf/arm_dsu_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/hisi-pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/index.rst (95%)
rename Documentation/{ => admin-guide}/perf/qcom_l2_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/qcom_l3_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/thunderx2-pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/xgene-pmu.rst (100%)
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 0066b198cad4..b7e6d18f80ca 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -38,6 +38,7 @@ problems and bugs in particular.
ramoops
dynamic-debug-howto
init
+ perf/index
This is the beginning of a section with information of interest to
application developers. Documents covering various aspects of the kernel
diff --git a/Documentation/perf/arm-ccn.rst b/Documentation/admin-guide/perf/arm-ccn.rst
similarity index 100%
rename from Documentation/perf/arm-ccn.rst
rename to Documentation/admin-guide/perf/arm-ccn.rst
diff --git a/Documentation/perf/arm_dsu_pmu.rst b/Documentation/admin-guide/perf/arm_dsu_pmu.rst
similarity index 100%
rename from Documentation/perf/arm_dsu_pmu.rst
rename to Documentation/admin-guide/perf/arm_dsu_pmu.rst
diff --git a/Documentation/perf/hisi-pmu.rst b/Documentation/admin-guide/perf/hisi-pmu.rst
similarity index 100%
rename from Documentation/perf/hisi-pmu.rst
rename to Documentation/admin-guide/perf/hisi-pmu.rst
diff --git a/Documentation/perf/index.rst b/Documentation/admin-guide/perf/index.rst
similarity index 95%
rename from Documentation/perf/index.rst
rename to Documentation/admin-guide/perf/index.rst
index 4bf848e27f26..9d445451ea18 100644
--- a/Documentation/perf/index.rst
+++ b/Documentation/admin-guide/perf/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
===========================
Performance monitor support
===========================
diff --git a/Documentation/perf/qcom_l2_pmu.rst b/Documentation/admin-guide/perf/qcom_l2_pmu.rst
similarity index 100%
rename from Documentation/perf/qcom_l2_pmu.rst
rename to Documentation/admin-guide/perf/qcom_l2_pmu.rst
diff --git a/Documentation/perf/qcom_l3_pmu.rst b/Documentation/admin-guide/perf/qcom_l3_pmu.rst
similarity index 100%
rename from Documentation/perf/qcom_l3_pmu.rst
rename to Documentation/admin-guide/perf/qcom_l3_pmu.rst
diff --git a/Documentation/perf/thunderx2-pmu.rst b/Documentation/admin-guide/perf/thunderx2-pmu.rst
similarity index 100%
rename from Documentation/perf/thunderx2-pmu.rst
rename to Documentation/admin-guide/perf/thunderx2-pmu.rst
diff --git a/Documentation/perf/xgene-pmu.rst b/Documentation/admin-guide/perf/xgene-pmu.rst
similarity index 100%
rename from Documentation/perf/xgene-pmu.rst
rename to Documentation/admin-guide/perf/xgene-pmu.rst
diff --git a/MAINTAINERS b/MAINTAINERS
index 9d3a408f5ce1..55996c9f2e0a 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1139,7 +1139,7 @@ APPLIED MICRO (APM) X-GENE SOC PMU
M: Khuong Dinh <[email protected]>
S: Supported
F: drivers/perf/xgene_pmu.c
-F: Documentation/perf/xgene-pmu.rst
+F: Documentation/admin-guide/perf/xgene-pmu.rst
F: Documentation/devicetree/bindings/perf/apm-xgene-pmu.txt
APTINA CAMERA SENSOR PLL
@@ -7207,7 +7207,7 @@ M: Shaokun Zhang <[email protected]>
W: http://www.hisilicon.com
S: Supported
F: drivers/perf/hisilicon
-F: Documentation/perf/hisi-pmu.rst
+F: Documentation/admin-guide/perf/hisi-pmu.rst
HISILICON ROCE DRIVER
M: Lijun Ou <[email protected]>
diff --git a/drivers/perf/qcom_l3_pmu.c b/drivers/perf/qcom_l3_pmu.c
index 90f88ce5192b..656e830798d9 100644
--- a/drivers/perf/qcom_l3_pmu.c
+++ b/drivers/perf/qcom_l3_pmu.c
@@ -8,7 +8,7 @@
* the slices. User space needs to aggregate to individual counts to provide
* a global picture.
*
- * See Documentation/perf/qcom_l3_pmu.rst for more details.
+ * See Documentation/admin-guide/perf/qcom_l3_pmu.rst for more details.
*
* Copyright (c) 2015-2017, The Linux Foundation. All rights reserved.
*/
--
2.21.0
The locking directory is part of the Kernel API bookset. Add
it to the index file.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/index.rst | 1 +
Documentation/locking/index.rst | 2 +-
2 files changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 075c732501a2..13c3188f6a68 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -96,6 +96,7 @@ needed).
driver-api/index
core-api/index
+ locking/index
accounting/index
block/index
cdrom/index
diff --git a/Documentation/locking/index.rst b/Documentation/locking/index.rst
index ef5da7fe9aac..626a463f7e42 100644
--- a/Documentation/locking/index.rst
+++ b/Documentation/locking/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
=======
locking
--
2.21.0
Most of the stuff here is related to the kAPI.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/driver-api/index.rst | 1 +
Documentation/{ => driver-api}/mmc/index.rst | 2 --
Documentation/{ => driver-api}/mmc/mmc-async-req.rst | 0
Documentation/{ => driver-api}/mmc/mmc-dev-attrs.rst | 0
Documentation/{ => driver-api}/mmc/mmc-dev-parts.rst | 0
Documentation/{ => driver-api}/mmc/mmc-tools.rst | 0
6 files changed, 1 insertion(+), 2 deletions(-)
rename Documentation/{ => driver-api}/mmc/index.rst (94%)
rename Documentation/{ => driver-api}/mmc/mmc-async-req.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-dev-attrs.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-dev-parts.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-tools.rst (100%)
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index a8b3634287de..55354eacc8bd 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -44,6 +44,7 @@ available subsections can be seen below.
miscellaneous
mei/index
mtd/index
+ mmc/index
nvdimm/index
w1
rapidio/index
diff --git a/Documentation/mmc/index.rst b/Documentation/driver-api/mmc/index.rst
similarity index 94%
rename from Documentation/mmc/index.rst
rename to Documentation/driver-api/mmc/index.rst
index 3305478ddadb..9aaf64951a8c 100644
--- a/Documentation/mmc/index.rst
+++ b/Documentation/driver-api/mmc/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
========================
MMC/SD/SDIO card support
========================
diff --git a/Documentation/mmc/mmc-async-req.rst b/Documentation/driver-api/mmc/mmc-async-req.rst
similarity index 100%
rename from Documentation/mmc/mmc-async-req.rst
rename to Documentation/driver-api/mmc/mmc-async-req.rst
diff --git a/Documentation/mmc/mmc-dev-attrs.rst b/Documentation/driver-api/mmc/mmc-dev-attrs.rst
similarity index 100%
rename from Documentation/mmc/mmc-dev-attrs.rst
rename to Documentation/driver-api/mmc/mmc-dev-attrs.rst
diff --git a/Documentation/mmc/mmc-dev-parts.rst b/Documentation/driver-api/mmc/mmc-dev-parts.rst
similarity index 100%
rename from Documentation/mmc/mmc-dev-parts.rst
rename to Documentation/driver-api/mmc/mmc-dev-parts.rst
diff --git a/Documentation/mmc/mmc-tools.rst b/Documentation/driver-api/mmc/mmc-tools.rst
similarity index 100%
rename from Documentation/mmc/mmc-tools.rst
rename to Documentation/driver-api/mmc/mmc-tools.rst
--
2.21.0
The contents of leds driver docs is messy: it has lots of
admin-guide stuff and kernel internal ones, just like other
driver subsystems.
I'm opting to keep the dir at the same place and just add
a link to it. This makes clearer that this require changes.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/index.rst | 1 +
Documentation/leds/index.rst | 2 +-
2 files changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 2f9bf37b8989..3a17a621896c 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -91,6 +91,7 @@ needed).
driver-api/index
core-api/index
+ leds/index
media/index
networking/index
input/index
diff --git a/Documentation/leds/index.rst b/Documentation/leds/index.rst
index 9885f7c1b75d..060f4e485897 100644
--- a/Documentation/leds/index.rst
+++ b/Documentation/leds/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
====
LEDs
--
2.21.0
This is actually a subsystem description, with contains both
kAPI and uAPI.
While it should ideally be slplit, let's place it at driver-api,
as most things are related to kAPI and driver-specific info.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/admin-guide/index.rst | 1 +
Documentation/{driver-api => admin-guide}/rapidio.rst | 0
Documentation/driver-api/index.rst | 2 +-
Documentation/{ => driver-api}/rapidio/index.rst | 2 --
Documentation/{ => driver-api}/rapidio/mport_cdev.rst | 0
Documentation/{ => driver-api}/rapidio/rapidio.rst | 0
Documentation/{ => driver-api}/rapidio/rio_cm.rst | 0
Documentation/{ => driver-api}/rapidio/sysfs.rst | 0
Documentation/{ => driver-api}/rapidio/tsi721.rst | 0
drivers/rapidio/Kconfig | 2 +-
10 files changed, 3 insertions(+), 4 deletions(-)
rename Documentation/{driver-api => admin-guide}/rapidio.rst (100%)
rename Documentation/{ => driver-api}/rapidio/index.rst (94%)
rename Documentation/{ => driver-api}/rapidio/mport_cdev.rst (100%)
rename Documentation/{ => driver-api}/rapidio/rapidio.rst (100%)
rename Documentation/{ => driver-api}/rapidio/rio_cm.rst (100%)
rename Documentation/{ => driver-api}/rapidio/sysfs.rst (100%)
rename Documentation/{ => driver-api}/rapidio/tsi721.rst (100%)
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 8001917ee012..0066b198cad4 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -61,6 +61,7 @@ configure specific aspects of kernel behavior to your liking.
parport
md
module-signing
+ rapidio
sysrq
unicode
vga-softcursor
diff --git a/Documentation/driver-api/rapidio.rst b/Documentation/admin-guide/rapidio.rst
similarity index 100%
rename from Documentation/driver-api/rapidio.rst
rename to Documentation/admin-guide/rapidio.rst
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 4e503e360860..93c6c9a98c41 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -44,7 +44,7 @@ available subsections can be seen below.
miscellaneous
mei/index
w1
- rapidio
+ rapidio/index
s390-drivers
vme
80211/index
diff --git a/Documentation/rapidio/index.rst b/Documentation/driver-api/rapidio/index.rst
similarity index 94%
rename from Documentation/rapidio/index.rst
rename to Documentation/driver-api/rapidio/index.rst
index ab7b5541b346..4c5e51a05134 100644
--- a/Documentation/rapidio/index.rst
+++ b/Documentation/driver-api/rapidio/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
===========================
The Linux RapidIO Subsystem
===========================
diff --git a/Documentation/rapidio/mport_cdev.rst b/Documentation/driver-api/rapidio/mport_cdev.rst
similarity index 100%
rename from Documentation/rapidio/mport_cdev.rst
rename to Documentation/driver-api/rapidio/mport_cdev.rst
diff --git a/Documentation/rapidio/rapidio.rst b/Documentation/driver-api/rapidio/rapidio.rst
similarity index 100%
rename from Documentation/rapidio/rapidio.rst
rename to Documentation/driver-api/rapidio/rapidio.rst
diff --git a/Documentation/rapidio/rio_cm.rst b/Documentation/driver-api/rapidio/rio_cm.rst
similarity index 100%
rename from Documentation/rapidio/rio_cm.rst
rename to Documentation/driver-api/rapidio/rio_cm.rst
diff --git a/Documentation/rapidio/sysfs.rst b/Documentation/driver-api/rapidio/sysfs.rst
similarity index 100%
rename from Documentation/rapidio/sysfs.rst
rename to Documentation/driver-api/rapidio/sysfs.rst
diff --git a/Documentation/rapidio/tsi721.rst b/Documentation/driver-api/rapidio/tsi721.rst
similarity index 100%
rename from Documentation/rapidio/tsi721.rst
rename to Documentation/driver-api/rapidio/tsi721.rst
diff --git a/drivers/rapidio/Kconfig b/drivers/rapidio/Kconfig
index 467e8fa06904..677d1aff61b7 100644
--- a/drivers/rapidio/Kconfig
+++ b/drivers/rapidio/Kconfig
@@ -86,7 +86,7 @@ config RAPIDIO_CHMAN
This option includes RapidIO channelized messaging driver which
provides socket-like interface to allow sharing of single RapidIO
messaging mailbox between multiple user-space applications.
- See "Documentation/rapidio/rio_cm.rst" for driver description.
+ See "Documentation/driver-api/rapidio/rio_cm.rst" for driver description.
config RAPIDIO_MPORT_CDEV
tristate "RapidIO /dev mport device driver"
--
2.21.0
As stated at the documentation, this is meant to be for
users to better understand namespaces.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/admin-guide/index.rst | 1 +
.../{ => admin-guide}/namespaces/compatibility-list.rst | 0
Documentation/{ => admin-guide}/namespaces/index.rst | 2 --
Documentation/{ => admin-guide}/namespaces/resource-control.rst | 0
4 files changed, 1 insertion(+), 2 deletions(-)
rename Documentation/{ => admin-guide}/namespaces/compatibility-list.rst (100%)
rename Documentation/{ => admin-guide}/namespaces/index.rst (91%)
rename Documentation/{ => admin-guide}/namespaces/resource-control.rst (100%)
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index b7e6d18f80ca..42819addebc6 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -76,6 +76,7 @@ configure specific aspects of kernel behavior to your liking.
thunderbolt
LSM/index
mm/index
+ namespaces/index
perf-security
acpi/index
diff --git a/Documentation/namespaces/compatibility-list.rst b/Documentation/admin-guide/namespaces/compatibility-list.rst
similarity index 100%
rename from Documentation/namespaces/compatibility-list.rst
rename to Documentation/admin-guide/namespaces/compatibility-list.rst
diff --git a/Documentation/namespaces/index.rst b/Documentation/admin-guide/namespaces/index.rst
similarity index 91%
rename from Documentation/namespaces/index.rst
rename to Documentation/admin-guide/namespaces/index.rst
index bf40625dd11a..713ec4949fa7 100644
--- a/Documentation/namespaces/index.rst
+++ b/Documentation/admin-guide/namespaces/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
==========
Namespaces
==========
diff --git a/Documentation/namespaces/resource-control.rst b/Documentation/admin-guide/namespaces/resource-control.rst
similarity index 100%
rename from Documentation/namespaces/resource-control.rst
rename to Documentation/admin-guide/namespaces/resource-control.rst
--
2.21.0
This is intented for Kernel hackers audience.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/driver-api/index.rst | 1 +
Documentation/{interconnect => driver-api}/interconnect.rst | 2 --
MAINTAINERS | 2 +-
3 files changed, 2 insertions(+), 3 deletions(-)
rename Documentation/{interconnect => driver-api}/interconnect.rst (99%)
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 2a0b57f12d1a..97bab578ea72 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -35,6 +35,7 @@ available subsections can be seen below.
spi
i2c
i3c/index
+ interconnect
hsi
edac
scsi
diff --git a/Documentation/interconnect/interconnect.rst b/Documentation/driver-api/interconnect.rst
similarity index 99%
rename from Documentation/interconnect/interconnect.rst
rename to Documentation/driver-api/interconnect.rst
index 56e331dab70e..c3e004893796 100644
--- a/Documentation/interconnect/interconnect.rst
+++ b/Documentation/driver-api/interconnect.rst
@@ -1,7 +1,5 @@
.. SPDX-License-Identifier: GPL-2.0
-:orphan:
-
=====================================
GENERIC SYSTEM INTERCONNECT SUBSYSTEM
=====================================
diff --git a/MAINTAINERS b/MAINTAINERS
index 55996c9f2e0a..524e2c4300dc 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -8273,7 +8273,7 @@ INTERCONNECT API
M: Georgi Djakov <[email protected]>
L: [email protected]
S: Maintained
-F: Documentation/interconnect/
+F: Documentation/driver-api/interconnect.rst
F: Documentation/devicetree/bindings/interconnect/
F: drivers/interconnect/
F: include/dt-bindings/interconnect/
--
2.21.0
Those are subsystem docs, with a mix of kABI and user-faced
docs. While they're not split, keep the dirs where they are,
adding just a pointer to the main index.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/accounting/index.rst | 2 +-
Documentation/block/index.rst | 2 +-
Documentation/hid/index.rst | 2 +-
Documentation/iio/index.rst | 2 +-
Documentation/index.rst | 4 ++++
5 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/Documentation/accounting/index.rst b/Documentation/accounting/index.rst
index e1f6284b5ff3..9369d8bf32be 100644
--- a/Documentation/accounting/index.rst
+++ b/Documentation/accounting/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
==========
Accounting
diff --git a/Documentation/block/index.rst b/Documentation/block/index.rst
index 8cd226a0e86e..3fa7a52fafa4 100644
--- a/Documentation/block/index.rst
+++ b/Documentation/block/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
=====
Block
diff --git a/Documentation/hid/index.rst b/Documentation/hid/index.rst
index af4324902622..737d66dc16a1 100644
--- a/Documentation/hid/index.rst
+++ b/Documentation/hid/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
=============================
Human Interface Devices (HID)
diff --git a/Documentation/iio/index.rst b/Documentation/iio/index.rst
index 0593dca89a94..58b7a4ebac51 100644
--- a/Documentation/iio/index.rst
+++ b/Documentation/iio/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
==============
Industrial I/O
diff --git a/Documentation/index.rst b/Documentation/index.rst
index f898def833f4..879849b60c02 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -92,6 +92,10 @@ needed).
driver-api/index
core-api/index
+ accounting/index
+ block/index
+ hid/index
+ iio/index
leds/index
media/index
networking/index
--
2.21.0
The descriptions here are from Kernel driver's PoV.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/driver-api/index.rst | 1 +
Documentation/{ => driver-api}/nvdimm/btt.rst | 0
Documentation/{ => driver-api}/nvdimm/index.rst | 2 --
Documentation/{ => driver-api}/nvdimm/nvdimm.rst | 0
Documentation/{ => driver-api}/nvdimm/security.rst | 0
drivers/nvdimm/Kconfig | 2 +-
6 files changed, 2 insertions(+), 3 deletions(-)
rename Documentation/{ => driver-api}/nvdimm/btt.rst (100%)
rename Documentation/{ => driver-api}/nvdimm/index.rst (94%)
rename Documentation/{ => driver-api}/nvdimm/nvdimm.rst (100%)
rename Documentation/{ => driver-api}/nvdimm/security.rst (100%)
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 93c6c9a98c41..41f5ce7dc34c 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -43,6 +43,7 @@ available subsections can be seen below.
mtdnand
miscellaneous
mei/index
+ nvdimm/index
w1
rapidio/index
s390-drivers
diff --git a/Documentation/nvdimm/btt.rst b/Documentation/driver-api/nvdimm/btt.rst
similarity index 100%
rename from Documentation/nvdimm/btt.rst
rename to Documentation/driver-api/nvdimm/btt.rst
diff --git a/Documentation/nvdimm/index.rst b/Documentation/driver-api/nvdimm/index.rst
similarity index 94%
rename from Documentation/nvdimm/index.rst
rename to Documentation/driver-api/nvdimm/index.rst
index 1a3402d3775e..19dc8ee371dc 100644
--- a/Documentation/nvdimm/index.rst
+++ b/Documentation/driver-api/nvdimm/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
===================================
Non-Volatile Memory Device (NVDIMM)
===================================
diff --git a/Documentation/nvdimm/nvdimm.rst b/Documentation/driver-api/nvdimm/nvdimm.rst
similarity index 100%
rename from Documentation/nvdimm/nvdimm.rst
rename to Documentation/driver-api/nvdimm/nvdimm.rst
diff --git a/Documentation/nvdimm/security.rst b/Documentation/driver-api/nvdimm/security.rst
similarity index 100%
rename from Documentation/nvdimm/security.rst
rename to Documentation/driver-api/nvdimm/security.rst
diff --git a/drivers/nvdimm/Kconfig b/drivers/nvdimm/Kconfig
index e89c1c332407..a5fde15e91d3 100644
--- a/drivers/nvdimm/Kconfig
+++ b/drivers/nvdimm/Kconfig
@@ -33,7 +33,7 @@ config BLK_DEV_PMEM
Documentation/admin-guide/kernel-parameters.rst). This driver converts
these persistent memory ranges into block devices that are
capable of DAX (direct-access) file system mappings. See
- Documentation/nvdimm/nvdimm.rst for more details.
+ Documentation/driver-api/nvdimm/nvdimm.rst for more details.
Say Y if you want to use an NVDIMM
--
2.21.0
While 100% of its contents is userspace, let's keep the dir
at the same place, as this is a well-known location.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/index.rst | 1 +
Documentation/ioctl/index.rst | 2 +-
Documentation/ioctl/ioctl-number.rst | 2 --
3 files changed, 2 insertions(+), 3 deletions(-)
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 3a17a621896c..95db26bf2899 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -56,6 +56,7 @@ the kernel interface as seen by application developers.
:maxdepth: 2
userspace-api/index
+ ioctl/index
Introduction to kernel development
diff --git a/Documentation/ioctl/index.rst b/Documentation/ioctl/index.rst
index 1a6f437566e3..0f0a857f6615 100644
--- a/Documentation/ioctl/index.rst
+++ b/Documentation/ioctl/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
======
IOCTLs
diff --git a/Documentation/ioctl/ioctl-number.rst b/Documentation/ioctl/ioctl-number.rst
index e6d07badafb1..597111dcca0c 100644
--- a/Documentation/ioctl/ioctl-number.rst
+++ b/Documentation/ioctl/ioctl-number.rst
@@ -1,5 +1,3 @@
-:orphan:
-
=============
Ioctl Numbers
=============
--
2.21.0
Most of the descriptions here are oriented to a Kernel developer.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/driver-api/index.rst | 1 +
Documentation/{ => driver-api}/nfc/index.rst | 2 --
Documentation/{ => driver-api}/nfc/nfc-hci.rst | 0
Documentation/{ => driver-api}/nfc/nfc-pn544.rst | 0
4 files changed, 1 insertion(+), 2 deletions(-)
rename Documentation/{ => driver-api}/nfc/index.rst (92%)
rename Documentation/{ => driver-api}/nfc/nfc-hci.rst (100%)
rename Documentation/{ => driver-api}/nfc/nfc-pn544.rst (100%)
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 488c0347fa98..a8b3634287de 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -55,6 +55,7 @@ available subsections can be seen below.
pinctl
gpio/index
misc_devices
+ nfc/index
dmaengine/index
slimbus
soundwire/index
diff --git a/Documentation/nfc/index.rst b/Documentation/driver-api/nfc/index.rst
similarity index 92%
rename from Documentation/nfc/index.rst
rename to Documentation/driver-api/nfc/index.rst
index 4f4947fce80d..3afb2c0c2e3c 100644
--- a/Documentation/nfc/index.rst
+++ b/Documentation/driver-api/nfc/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
========================
Near Field Communication
========================
diff --git a/Documentation/nfc/nfc-hci.rst b/Documentation/driver-api/nfc/nfc-hci.rst
similarity index 100%
rename from Documentation/nfc/nfc-hci.rst
rename to Documentation/driver-api/nfc/nfc-hci.rst
diff --git a/Documentation/nfc/nfc-pn544.rst b/Documentation/driver-api/nfc/nfc-pn544.rst
similarity index 100%
rename from Documentation/nfc/nfc-pn544.rst
rename to Documentation/driver-api/nfc/nfc-pn544.rst
--
2.21.0
The stuff under sysctl describes /sys interface from userspace
point of view. So, add it to the admin-guide and remove the
:orphan: from its index file.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
CREDITS | 2 +-
Documentation/admin-guide/index.rst | 1 +
Documentation/admin-guide/kernel-parameters.txt | 2 +-
Documentation/admin-guide/mm/index.rst | 2 +-
Documentation/admin-guide/mm/ksm.rst | 2 +-
Documentation/{ => admin-guide}/sysctl/abi.rst | 0
Documentation/{ => admin-guide}/sysctl/fs.rst | 0
Documentation/{ => admin-guide}/sysctl/index.rst | 2 --
Documentation/{ => admin-guide}/sysctl/kernel.rst | 0
Documentation/{ => admin-guide}/sysctl/net.rst | 0
Documentation/{ => admin-guide}/sysctl/sunrpc.rst | 0
Documentation/{ => admin-guide}/sysctl/user.rst | 0
Documentation/{ => admin-guide}/sysctl/vm.rst | 0
Documentation/core-api/printk-formats.rst | 2 +-
Documentation/filesystems/proc.txt | 2 +-
Documentation/networking/ip-sysctl.txt | 2 +-
Documentation/vm/unevictable-lru.rst | 2 +-
fs/proc/Kconfig | 2 +-
kernel/panic.c | 2 +-
mm/swap.c | 2 +-
20 files changed, 12 insertions(+), 13 deletions(-)
rename Documentation/{ => admin-guide}/sysctl/abi.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/fs.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/index.rst (99%)
rename Documentation/{ => admin-guide}/sysctl/kernel.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/net.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/sunrpc.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/user.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/vm.rst (100%)
diff --git a/CREDITS b/CREDITS
index beac0c81d081..401c5092bbf9 100644
--- a/CREDITS
+++ b/CREDITS
@@ -3120,7 +3120,7 @@ S: France
N: Rik van Riel
E: [email protected]
W: http://www.surriel.com/
-D: Linux-MM site, Documentation/sysctl/*, swap/mm readaround
+D: Linux-MM site, Documentation/admin-guide/sysctl/*, swap/mm readaround
D: kswapd fixes, random kernel hacker, rmap VM,
D: nl.linux.org administrator, minor scheduler additions
S: Red Hat Boston
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index e0763c51b024..acd0efa46e9d 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -16,6 +16,7 @@ etc.
README
kernel-parameters
devices
+ sysctl/index
This section describes CPU vulnerabilities and their mitigations.
diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index b2007fb4daf0..a3d3da5baacb 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -3170,7 +3170,7 @@
numa_zonelist_order= [KNL, BOOT] Select zonelist order for NUMA.
'node', 'default' can be specified
This can be set from sysctl after boot.
- See Documentation/sysctl/vm.rst for details.
+ See Documentation/admin-guide/sysctl/vm.rst for details.
ohci1394_dma=early [HW] enable debugging via the ohci1394 driver.
See Documentation/debugging-via-ohci1394.txt for more
diff --git a/Documentation/admin-guide/mm/index.rst b/Documentation/admin-guide/mm/index.rst
index f5e92f33f96e..5f61a6c429e0 100644
--- a/Documentation/admin-guide/mm/index.rst
+++ b/Documentation/admin-guide/mm/index.rst
@@ -11,7 +11,7 @@ processes address space and many other cool things.
Linux memory management is a complex system with many configurable
settings. Most of these settings are available via ``/proc``
filesystem and can be quired and adjusted using ``sysctl``. These APIs
-are described in Documentation/sysctl/vm.rst and in `man 5 proc`_.
+are described in Documentation/admin-guide/sysctl/vm.rst and in `man 5 proc`_.
.. _man 5 proc: http://man7.org/linux/man-pages/man5/proc.5.html
diff --git a/Documentation/admin-guide/mm/ksm.rst b/Documentation/admin-guide/mm/ksm.rst
index 7b2b8767c0b4..874eb0c77d34 100644
--- a/Documentation/admin-guide/mm/ksm.rst
+++ b/Documentation/admin-guide/mm/ksm.rst
@@ -59,7 +59,7 @@ MADV_UNMERGEABLE is applied to a range which was never MADV_MERGEABLE.
If a region of memory must be split into at least one new MADV_MERGEABLE
or MADV_UNMERGEABLE region, the madvise may return ENOMEM if the process
-will exceed ``vm.max_map_count`` (see Documentation/sysctl/vm.rst).
+will exceed ``vm.max_map_count`` (see Documentation/admin-guide/sysctl/vm.rst).
Like other madvise calls, they are intended for use on mapped areas of
the user address space: they will report ENOMEM if the specified range
diff --git a/Documentation/sysctl/abi.rst b/Documentation/admin-guide/sysctl/abi.rst
similarity index 100%
rename from Documentation/sysctl/abi.rst
rename to Documentation/admin-guide/sysctl/abi.rst
diff --git a/Documentation/sysctl/fs.rst b/Documentation/admin-guide/sysctl/fs.rst
similarity index 100%
rename from Documentation/sysctl/fs.rst
rename to Documentation/admin-guide/sysctl/fs.rst
diff --git a/Documentation/sysctl/index.rst b/Documentation/admin-guide/sysctl/index.rst
similarity index 99%
rename from Documentation/sysctl/index.rst
rename to Documentation/admin-guide/sysctl/index.rst
index efbcde8c1c9c..03346f98c7b9 100644
--- a/Documentation/sysctl/index.rst
+++ b/Documentation/admin-guide/sysctl/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
===========================
Documentation for /proc/sys
===========================
diff --git a/Documentation/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
similarity index 100%
rename from Documentation/sysctl/kernel.rst
rename to Documentation/admin-guide/sysctl/kernel.rst
diff --git a/Documentation/sysctl/net.rst b/Documentation/admin-guide/sysctl/net.rst
similarity index 100%
rename from Documentation/sysctl/net.rst
rename to Documentation/admin-guide/sysctl/net.rst
diff --git a/Documentation/sysctl/sunrpc.rst b/Documentation/admin-guide/sysctl/sunrpc.rst
similarity index 100%
rename from Documentation/sysctl/sunrpc.rst
rename to Documentation/admin-guide/sysctl/sunrpc.rst
diff --git a/Documentation/sysctl/user.rst b/Documentation/admin-guide/sysctl/user.rst
similarity index 100%
rename from Documentation/sysctl/user.rst
rename to Documentation/admin-guide/sysctl/user.rst
diff --git a/Documentation/sysctl/vm.rst b/Documentation/admin-guide/sysctl/vm.rst
similarity index 100%
rename from Documentation/sysctl/vm.rst
rename to Documentation/admin-guide/sysctl/vm.rst
diff --git a/Documentation/core-api/printk-formats.rst b/Documentation/core-api/printk-formats.rst
index 1d8e748f909f..c6224d039bcb 100644
--- a/Documentation/core-api/printk-formats.rst
+++ b/Documentation/core-api/printk-formats.rst
@@ -119,7 +119,7 @@ Kernel Pointers
For printing kernel pointers which should be hidden from unprivileged
users. The behaviour of %pK depends on the kptr_restrict sysctl - see
-Documentation/sysctl/kernel.rst for more details.
+Documentation/admin-guide/sysctl/kernel.rst for more details.
Unmodified Addresses
--------------------
diff --git a/Documentation/filesystems/proc.txt b/Documentation/filesystems/proc.txt
index 52ec004a4a8b..be56af8dbb88 100644
--- a/Documentation/filesystems/proc.txt
+++ b/Documentation/filesystems/proc.txt
@@ -1479,7 +1479,7 @@ review the kernel documentation in the directory /usr/src/linux/Documentation.
This chapter is heavily based on the documentation included in the pre 2.2
kernels, and became part of it in version 2.2.1 of the Linux kernel.
-Please see: Documentation/sysctl/ directory for descriptions of these
+Please see: Documentation/admin-guide/sysctl/ directory for descriptions of these
entries.
------------------------------------------------------------------------------
diff --git a/Documentation/networking/ip-sysctl.txt b/Documentation/networking/ip-sysctl.txt
index 0f8e1c544e1e..864a5921e9d7 100644
--- a/Documentation/networking/ip-sysctl.txt
+++ b/Documentation/networking/ip-sysctl.txt
@@ -2284,7 +2284,7 @@ addr_scope_policy - INTEGER
/proc/sys/net/core/*
- Please see: Documentation/sysctl/net.rst for descriptions of these entries.
+ Please see: Documentation/admin-guide/sysctl/net.rst for descriptions of these entries.
/proc/sys/net/unix/*
diff --git a/Documentation/vm/unevictable-lru.rst b/Documentation/vm/unevictable-lru.rst
index 8ba656f37cd8..109052215bce 100644
--- a/Documentation/vm/unevictable-lru.rst
+++ b/Documentation/vm/unevictable-lru.rst
@@ -439,7 +439,7 @@ Compacting MLOCKED Pages
The unevictable LRU can be scanned for compactable regions and the default
behavior is to do so. /proc/sys/vm/compact_unevictable_allowed controls
-this behavior (see Documentation/sysctl/vm.rst). Once scanning of the
+this behavior (see Documentation/admin-guide/sysctl/vm.rst). Once scanning of the
unevictable LRU is enabled, the work of compaction is mostly handled by
the page migration code and the same work flow as described in MIGRATING
MLOCKED PAGES will apply.
diff --git a/fs/proc/Kconfig b/fs/proc/Kconfig
index cba429db95d9..cb5629bd5fff 100644
--- a/fs/proc/Kconfig
+++ b/fs/proc/Kconfig
@@ -73,7 +73,7 @@ config PROC_SYSCTL
interface is through /proc/sys. If you say Y here a tree of
modifiable sysctl entries will be generated beneath the
/proc/sys directory. They are explained in the files
- in <file:Documentation/sysctl/>. Note that enabling this
+ in <file:Documentation/admin-guide/sysctl/>. Note that enabling this
option will enlarge the kernel by at least 8 KB.
As it is generally a good thing, you should say Y here unless
diff --git a/kernel/panic.c b/kernel/panic.c
index e0ea74bbb41d..057540b6eee9 100644
--- a/kernel/panic.c
+++ b/kernel/panic.c
@@ -372,7 +372,7 @@ const struct taint_flag taint_flags[TAINT_FLAGS_COUNT] = {
/**
* print_tainted - return a string to represent the kernel taint state.
*
- * For individual taint flag meanings, see Documentation/sysctl/kernel.rst
+ * For individual taint flag meanings, see Documentation/admin-guide/sysctl/kernel.rst
*
* The string is overwritten by the next call to print_tainted(),
* but is always NULL terminated.
diff --git a/mm/swap.c b/mm/swap.c
index 83a2a15f4836..ae300397dfda 100644
--- a/mm/swap.c
+++ b/mm/swap.c
@@ -8,7 +8,7 @@
/*
* This file contains the default values for the operation of the
* Linux VM subsystem. Fine-tuning documentation can be found in
- * Documentation/sysctl/vm.rst.
+ * Documentation/admin-guide/sysctl/vm.rst.
* Started 18.12.91
* Swap aging added 23.2.95, Stephen Tweedie.
* Buffermem limits added 12.3.98, Rik van Riel.
--
2.21.0
The docs there were meant to be read by a Kernel developer.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/driver-api/index.rst | 1 +
Documentation/{ => driver-api}/md/index.rst | 2 --
Documentation/{ => driver-api}/md/md-cluster.rst | 0
Documentation/{ => driver-api}/md/raid5-cache.rst | 0
Documentation/{ => driver-api}/md/raid5-ppl.rst | 0
5 files changed, 1 insertion(+), 2 deletions(-)
rename Documentation/{ => driver-api}/md/index.rst (89%)
rename Documentation/{ => driver-api}/md/md-cluster.rst (100%)
rename Documentation/{ => driver-api}/md/raid5-cache.rst (100%)
rename Documentation/{ => driver-api}/md/raid5-ppl.rst (100%)
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 55354eacc8bd..2a0b57f12d1a 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -55,6 +55,7 @@ available subsections can be seen below.
firmware/index
pinctl
gpio/index
+ md/index
misc_devices
nfc/index
dmaengine/index
diff --git a/Documentation/md/index.rst b/Documentation/driver-api/md/index.rst
similarity index 89%
rename from Documentation/md/index.rst
rename to Documentation/driver-api/md/index.rst
index c4db34ed327d..205080891a1a 100644
--- a/Documentation/md/index.rst
+++ b/Documentation/driver-api/md/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
====
RAID
====
diff --git a/Documentation/md/md-cluster.rst b/Documentation/driver-api/md/md-cluster.rst
similarity index 100%
rename from Documentation/md/md-cluster.rst
rename to Documentation/driver-api/md/md-cluster.rst
diff --git a/Documentation/md/raid5-cache.rst b/Documentation/driver-api/md/raid5-cache.rst
similarity index 100%
rename from Documentation/md/raid5-cache.rst
rename to Documentation/driver-api/md/raid5-cache.rst
diff --git a/Documentation/md/raid5-ppl.rst b/Documentation/driver-api/md/raid5-ppl.rst
similarity index 100%
rename from Documentation/md/raid5-ppl.rst
rename to Documentation/driver-api/md/raid5-ppl.rst
--
2.21.0
On 6/28/19 15:30, Mauro Carvalho Chehab wrote:
> This is intented for Kernel hackers audience.
s/intented/intended/
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Reviewed-by: Georgi Djakov <[email protected]>
Thanks!
Georgi
> ---
> Documentation/driver-api/index.rst | 1 +
> Documentation/{interconnect => driver-api}/interconnect.rst | 2 --
> MAINTAINERS | 2 +-
> 3 files changed, 2 insertions(+), 3 deletions(-)
> rename Documentation/{interconnect => driver-api}/interconnect.rst (99%)
>
> diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
> index 2a0b57f12d1a..97bab578ea72 100644
> --- a/Documentation/driver-api/index.rst
> +++ b/Documentation/driver-api/index.rst
> @@ -35,6 +35,7 @@ available subsections can be seen below.
> spi
> i2c
> i3c/index
> + interconnect
> hsi
> edac
> scsi
> diff --git a/Documentation/interconnect/interconnect.rst b/Documentation/driver-api/interconnect.rst
> similarity index 99%
> rename from Documentation/interconnect/interconnect.rst
> rename to Documentation/driver-api/interconnect.rst
> index 56e331dab70e..c3e004893796 100644
> --- a/Documentation/interconnect/interconnect.rst
> +++ b/Documentation/driver-api/interconnect.rst
> @@ -1,7 +1,5 @@
> .. SPDX-License-Identifier: GPL-2.0
>
> -:orphan:
> -
> =====================================
> GENERIC SYSTEM INTERCONNECT SUBSYSTEM
> =====================================
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 55996c9f2e0a..524e2c4300dc 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -8273,7 +8273,7 @@ INTERCONNECT API
> M: Georgi Djakov <[email protected]>
> L: [email protected]
> S: Maintained
> -F: Documentation/interconnect/
> +F: Documentation/driver-api/interconnect.rst
> F: Documentation/devicetree/bindings/interconnect/
> F: drivers/interconnect/
> F: include/dt-bindings/interconnect/
>
On Fri, Jun 28, 2019 at 5:30 AM Mauro Carvalho Chehab
<[email protected]> wrote:
>
> The descriptions here are from Kernel driver's PoV.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Acked-by: Dan Williams <[email protected]>