* [PATCH v2 00/26] ReST conversion of text files without .txt extension @ 2019-07-26 12:51 Mauro Carvalho Chehab 2019-07-26 12:51 ` [PATCH v2 13/26] docs: parisc: convert to ReST and add to documentation body Mauro Carvalho Chehab 2019-07-26 13:05 ` [PATCH v2 00/26] ReST conversion of text files without .txt extension Mauro Carvalho Chehab 0 siblings, 2 replies; 3+ messages in thread From: Mauro Carvalho Chehab @ 2019-07-26 12:51 UTC (permalink / raw) To: Jonathan Corbet Cc: Mauro Carvalho Chehab, linux-doc, linux-kernel, linux-pm, linux-arm-kernel, linux-samsung-soc, linux-pci, linuxppc-dev, linux-scsi, devicetree, linux-i2c, linux-hwmon, linux-spi, linux-iio, linux-rtc, netdev, linux-parisc, openrisc, devel, linux-cifs, samba-technical, devel, dmaengine, alsa-devel, linux-mips, linux-wireless, rcu This series converts the text files under Documentation with doesn't end neither .txt or .rst and are not part of ABI or features. This series is at: https://git.linuxtv.org/mchehab/experimental.git/log/?h=rst_for_5_4_v3 And it is based on yesterday's upstream tree. After this series, we have ~320 files left to be converted to ReST. v2: - Added 3 files submitted for v5.3 that weren't merged yet; - markdown patch broken into two, per Rob's request; - rebased on the top of upstream master branch Mauro Carvalho Chehab (26): docs: power: add it to to the main documentation index docs: thermal: add it to the driver API docs: powerpc: convert docs to ReST and rename to *.rst docs: ubifs-authentication.md: convert to ReST docs: writing-schema.md: convert from markdown to ReST docs: i2c: convert to ReST and add to driver-api bookset docs: w1: convert to ReST and add to the kAPI group of docs spi: docs: convert to ReST and add it to the kABI bookset docs: ipmb: place it at driver-api and convert to ReST docs: packing: move it to core-api book and adjust markups docs: admin-guide: add auxdisplay files to it after conversion to ReST docs: README.buddha: convert to ReST and add to m68k book docs: parisc: convert to ReST and add to documentation body docs: openrisc: convert to ReST and add to documentation body docs: isdn: convert to ReST and add to kAPI bookset docs: fs: cifs: convert to ReST and add to admin-guide book docs: fs: convert docs without extension to ReST docs: fs: convert porting to ReST docs: index.rst: don't use genindex for pdf output docs: wimax: convert to ReST and add to admin-guide docs: mips: add to the documentation body as ReST docs: hwmon: pxe1610: convert to ReST format and add to the index docs: nios2: add it to the main Documentation body docs: net: convert two README files to ReST format docs: rcu: convert some articles from html to ReST docs: ABI: remove extension from sysfs-class-mic.txt Documentation/ABI/stable/sysfs-bus-w1 | 2 +- .../ABI/stable/sysfs-driver-w1_ds28e04 | 4 +- .../ABI/stable/sysfs-driver-w1_ds28ea00 | 2 +- .../{sysfs-class-mic.txt => sysfs-class-mic} | 0 Documentation/PCI/pci-error-recovery.rst | 2 +- .../Data-Structures/Data-Structures.html | 1391 ------- .../Data-Structures/Data-Structures.rst | 1163 ++++++ ...riods.html => Expedited-Grace-Periods.rst} | 949 ++--- .../Memory-Ordering/Tree-RCU-Diagram.html | 9 - ...ring.html => Tree-RCU-Memory-Ordering.rst} | 1181 +++--- .../RCU/Design/Requirements/Requirements.html | 3330 ----------------- .../RCU/Design/Requirements/Requirements.rst | 2662 +++++++++++++ Documentation/RCU/index.rst | 5 + Documentation/RCU/whatisRCU.txt | 4 +- .../auxdisplay/cfag12864b.rst} | 115 +- .../admin-guide/auxdisplay/index.rst | 16 + .../auxdisplay/ks0108.rst} | 53 +- .../AUTHORS => admin-guide/cifs/authors.rst} | 64 +- .../CHANGES => admin-guide/cifs/changes.rst} | 4 + Documentation/admin-guide/cifs/index.rst | 21 + .../cifs/introduction.rst} | 8 + .../cifs/TODO => admin-guide/cifs/todo.rst} | 87 +- .../README => admin-guide/cifs/usage.rst} | 560 +-- .../cifs/winucase_convert.pl | 0 Documentation/admin-guide/index.rst | 3 + .../wimax/i2400m.rst} | 145 +- Documentation/admin-guide/wimax/index.rst | 19 + .../wimax/wimax.rst} | 36 +- Documentation/core-api/index.rst | 3 +- .../{packing.txt => core-api/packing.rst} | 81 +- .../devicetree/bindings/i2c/i2c-mux-gpmux.txt | 2 +- .../{writing-schema.md => writing-schema.rst} | 137 +- Documentation/driver-api/dmaengine/index.rst | 2 +- Documentation/driver-api/index.rst | 2 + Documentation/driver-api/ipmb.rst | 2 +- Documentation/driver-api/soundwire/index.rst | 2 +- .../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 +- ...irectory-locking => directory-locking.rst} | 40 +- Documentation/filesystems/index.rst | 4 + .../filesystems/{Locking => locking.rst} | 257 +- .../nfs/{Exporting => exporting.rst} | 31 +- .../filesystems/{porting => porting.rst} | 824 ++-- ...entication.md => ubifs-authentication.rst} | 70 +- Documentation/filesystems/vfs.rst | 2 +- Documentation/hwmon/adm1021.rst | 2 +- Documentation/hwmon/adm1275.rst | 2 +- Documentation/hwmon/hih6130.rst | 2 +- Documentation/hwmon/ibm-cffps.rst | 2 +- Documentation/hwmon/index.rst | 1 + Documentation/hwmon/lm25066.rst | 2 +- Documentation/hwmon/max16064.rst | 2 +- Documentation/hwmon/max16065.rst | 2 +- Documentation/hwmon/max20751.rst | 2 +- Documentation/hwmon/max34440.rst | 2 +- Documentation/hwmon/max6650.rst | 2 +- Documentation/hwmon/max8688.rst | 2 +- Documentation/hwmon/menf21bmc.rst | 2 +- Documentation/hwmon/pcf8591.rst | 2 +- Documentation/hwmon/{pxe1610 => pxe1610.rst} | 33 +- Documentation/hwmon/sht3x.rst | 2 +- Documentation/hwmon/shtc1.rst | 2 +- Documentation/hwmon/tmp103.rst | 2 +- Documentation/hwmon/tps40422.rst | 2 +- Documentation/hwmon/ucd9000.rst | 2 +- Documentation/hwmon/ucd9200.rst | 2 +- Documentation/hwmon/via686a.rst | 2 +- Documentation/hwmon/zl6100.rst | 2 +- .../busses/{i2c-ali1535 => i2c-ali1535.rst} | 13 +- .../busses/{i2c-ali1563 => i2c-ali1563.rst} | 3 + .../busses/{i2c-ali15x3 => i2c-ali15x3.rst} | 64 +- .../busses/{i2c-amd-mp2 => i2c-amd-mp2.rst} | 14 +- .../i2c/busses/{i2c-amd756 => i2c-amd756.rst} | 8 +- .../busses/{i2c-amd8111 => i2c-amd8111.rst} | 14 +- .../{i2c-diolan-u2c => i2c-diolan-u2c.rst} | 3 + .../i2c/busses/{i2c-i801 => i2c-i801.rst} | 33 +- .../i2c/busses/{i2c-ismt => i2c-ismt.rst} | 20 +- .../busses/{i2c-mlxcpld => i2c-mlxcpld.rst} | 6 + .../busses/{i2c-nforce2 => i2c-nforce2.rst} | 33 +- .../{i2c-nvidia-gpu => i2c-nvidia-gpu.rst} | 6 +- .../i2c/busses/{i2c-ocores => i2c-ocores.rst} | 22 +- ...2c-parport-light => i2c-parport-light.rst} | 8 +- .../busses/{i2c-parport => i2c-parport.rst} | 164 +- .../busses/{i2c-pca-isa => i2c-pca-isa.rst} | 9 +- .../i2c/busses/{i2c-piix4 => i2c-piix4.rst} | 18 +- .../busses/{i2c-sis5595 => i2c-sis5595.rst} | 19 +- .../i2c/busses/{i2c-sis630 => i2c-sis630.rst} | 39 +- .../i2c/busses/{i2c-sis96x => i2c-sis96x.rst} | 31 +- .../busses/{i2c-taos-evm => i2c-taos-evm.rst} | 8 +- .../i2c/busses/{i2c-via => i2c-via.rst} | 28 +- .../i2c/busses/{i2c-viapro => i2c-viapro.rst} | 12 +- Documentation/i2c/busses/index.rst | 33 + .../i2c/busses/{scx200_acb => scx200_acb.rst} | 9 +- .../i2c/{dev-interface => dev-interface.rst} | 94 +- ...-considerations => dma-considerations.rst} | 0 .../i2c/{fault-codes => fault-codes.rst} | 5 +- .../i2c/{functionality => functionality.rst} | 22 +- ...ult-injection => gpio-fault-injection.rst} | 12 +- .../i2c/{i2c-protocol => i2c-protocol.rst} | 28 +- Documentation/i2c/{i2c-stub => i2c-stub.rst} | 20 +- .../i2c/{i2c-topology => i2c-topology.rst} | 68 +- Documentation/i2c/index.rst | 37 + ...ting-devices => instantiating-devices.rst} | 45 +- .../muxes/{i2c-mux-gpio => i2c-mux-gpio.rst} | 26 +- ...e-parameters => old-module-parameters.rst} | 27 +- ...eprom-backend => slave-eeprom-backend.rst} | 4 +- .../{slave-interface => slave-interface.rst} | 33 +- .../{smbus-protocol => smbus-protocol.rst} | 86 +- Documentation/i2c/{summary => summary.rst} | 6 +- ...en-bit-addresses => ten-bit-addresses.rst} | 5 + ...pgrading-clients => upgrading-clients.rst} | 204 +- .../{writing-clients => writing-clients.rst} | 94 +- Documentation/index.rst | 10 + .../isdn/{README.avmb1 => avmb1.rst} | 231 +- Documentation/isdn/{CREDITS => credits.rst} | 7 +- .../isdn/{README.gigaset => gigaset.rst} | 290 +- .../isdn/{README.hysdn => hysdn.rst} | 125 +- Documentation/isdn/index.rst | 24 + .../{INTERFACE.CAPI => interface_capi.rst} | 182 +- .../isdn/{README.mISDN => m_isdn.rst} | 5 +- .../m68k/{README.buddha => buddha-driver.rst} | 95 +- Documentation/m68k/index.rst | 1 + .../{AU1xxx_IDE.README => au1xxx_ide.rst} | 89 +- Documentation/mips/index.rst | 17 + .../networking/caif/{README => caif.rst} | 88 +- .../networking/device_drivers/index.rst | 2 +- Documentation/networking/index.rst | 2 +- .../{README => mac80211_hwsim.rst} | 28 +- Documentation/nios2/{README => nios2.rst} | 1 + Documentation/openrisc/index.rst | 18 + .../openrisc/{README => openrisc_port.rst} | 25 +- Documentation/openrisc/{TODO => todo.rst} | 9 +- .../parisc/{debugging => debugging.rst} | 7 + Documentation/parisc/index.rst | 18 + .../parisc/{registers => registers.rst} | 59 +- Documentation/power/index.rst | 2 +- .../{bootwrapper.txt => bootwrapper.rst} | 28 +- .../{cpu_families.txt => cpu_families.rst} | 23 +- .../{cpu_features.txt => cpu_features.rst} | 6 +- Documentation/powerpc/{cxl.txt => cxl.rst} | 46 +- .../powerpc/{cxlflash.txt => cxlflash.rst} | 10 +- .../{DAWR-POWER9.txt => dawr-power9.rst} | 15 +- Documentation/powerpc/{dscr.txt => dscr.rst} | 18 +- ...ecovery.txt => eeh-pci-error-recovery.rst} | 108 +- ...ed-dump.txt => firmware-assisted-dump.rst} | 117 +- Documentation/powerpc/{hvcs.txt => hvcs.rst} | 108 +- Documentation/powerpc/index.rst | 34 + Documentation/powerpc/isa-versions.rst | 15 +- .../powerpc/{mpc52xx.txt => mpc52xx.rst} | 12 +- ...nv.txt => pci_iov_resource_on_powernv.rst} | 15 +- .../powerpc/{pmu-ebb.txt => pmu-ebb.rst} | 1 + .../powerpc/{ptrace.txt => ptrace.rst} | 169 +- .../{qe_firmware.txt => qe_firmware.rst} | 37 +- .../{syscall64-abi.txt => syscall64-abi.rst} | 29 +- ...al_memory.txt => transactional_memory.rst} | 45 +- Documentation/sound/index.rst | 2 +- .../spi/{butterfly => butterfly.rst} | 44 +- Documentation/spi/index.rst | 22 + Documentation/spi/{pxa2xx => pxa2xx.rst} | 95 +- .../spi/{spi-lm70llp => spi-lm70llp.rst} | 17 +- .../spi/{spi-sc18is602 => spi-sc18is602.rst} | 5 +- .../spi/{spi-summary => spi-summary.rst} | 105 +- Documentation/spi/{spidev => spidev.rst} | 30 +- Documentation/w1/index.rst | 21 + .../w1/masters/{ds2482 => ds2482.rst} | 16 +- .../w1/masters/{ds2490 => ds2490.rst} | 6 +- Documentation/w1/masters/index.rst | 14 + .../w1/masters/{mxc-w1 => mxc-w1.rst} | 13 +- .../w1/masters/{omap-hdq => omap-hdq.rst} | 12 +- .../w1/masters/{w1-gpio => w1-gpio.rst} | 21 +- Documentation/w1/slaves/index.rst | 16 + .../w1/slaves/{w1_ds2406 => w1_ds2406.rst} | 4 +- .../w1/slaves/{w1_ds2413 => w1_ds2413.rst} | 9 + .../w1/slaves/{w1_ds2423 => w1_ds2423.rst} | 27 +- .../w1/slaves/{w1_ds2438 => w1_ds2438.rst} | 10 +- .../w1/slaves/{w1_ds28e04 => w1_ds28e04.rst} | 5 + .../w1/slaves/{w1_ds28e17 => w1_ds28e17.rst} | 16 +- .../w1/slaves/{w1_therm => w1_therm.rst} | 11 +- .../w1/{w1.generic => w1-generic.rst} | 88 +- .../w1/{w1.netlink => w1-netlink.rst} | 89 +- MAINTAINERS | 68 +- arch/powerpc/kernel/exceptions-64s.S | 2 +- drivers/auxdisplay/Kconfig | 2 +- drivers/hwmon/atxp1.c | 2 +- drivers/hwmon/smm665.c | 2 +- drivers/i2c/Kconfig | 4 +- drivers/i2c/busses/Kconfig | 2 +- drivers/i2c/busses/i2c-i801.c | 2 +- drivers/i2c/busses/i2c-taos-evm.c | 2 +- drivers/i2c/i2c-core-base.c | 4 +- drivers/iio/dummy/iio_simple_dummy.c | 4 +- drivers/rtc/rtc-ds1374.c | 2 +- drivers/soc/fsl/qe/qe.c | 2 +- drivers/spi/Kconfig | 2 +- drivers/spi/spi-butterfly.c | 2 +- drivers/spi/spi-lm70llp.c | 2 +- drivers/staging/isdn/hysdn/Kconfig | 2 +- drivers/tty/hvc/hvcs.c | 2 +- fs/cifs/export.c | 2 +- fs/exportfs/expfs.c | 2 +- fs/isofs/export.c | 2 +- fs/orangefs/file.c | 2 +- fs/orangefs/orangefs-kernel.h | 2 +- include/linux/dcache.h | 2 +- include/linux/exportfs.h | 2 +- include/linux/i2c.h | 2 +- include/linux/platform_data/sc18is602.h | 2 +- include/linux/thermal.h | 4 +- include/soc/fsl/qe/qe.h | 2 +- 216 files changed, 9148 insertions(+), 8672 deletions(-) rename Documentation/ABI/testing/{sysfs-class-mic.txt => sysfs-class-mic} (100%) delete mode 100644 Documentation/RCU/Design/Data-Structures/Data-Structures.html create mode 100644 Documentation/RCU/Design/Data-Structures/Data-Structures.rst rename Documentation/RCU/Design/Expedited-Grace-Periods/{Expedited-Grace-Periods.html => Expedited-Grace-Periods.rst} (15%) delete mode 100644 Documentation/RCU/Design/Memory-Ordering/Tree-RCU-Diagram.html rename Documentation/RCU/Design/Memory-Ordering/{Tree-RCU-Memory-Ordering.html => Tree-RCU-Memory-Ordering.rst} (10%) delete mode 100644 Documentation/RCU/Design/Requirements/Requirements.html create mode 100644 Documentation/RCU/Design/Requirements/Requirements.rst rename Documentation/{auxdisplay/cfag12864b => admin-guide/auxdisplay/cfag12864b.rst} (26%) create mode 100644 Documentation/admin-guide/auxdisplay/index.rst rename Documentation/{auxdisplay/ks0108 => admin-guide/auxdisplay/ks0108.rst} (32%) rename Documentation/{filesystems/cifs/AUTHORS => admin-guide/cifs/authors.rst} (60%) rename Documentation/{filesystems/cifs/CHANGES => admin-guide/cifs/changes.rst} (91%) create mode 100644 Documentation/admin-guide/cifs/index.rst rename Documentation/{filesystems/cifs/cifs.txt => admin-guide/cifs/introduction.rst} (98%) rename Documentation/{filesystems/cifs/TODO => admin-guide/cifs/todo.rst} (58%) rename Documentation/{filesystems/cifs/README => admin-guide/cifs/usage.rst} (72%) rename Documentation/{filesystems => admin-guide}/cifs/winucase_convert.pl (100%) rename Documentation/{wimax/README.i2400m => admin-guide/wimax/i2400m.rst} (69%) create mode 100644 Documentation/admin-guide/wimax/index.rst rename Documentation/{wimax/README.wimax => admin-guide/wimax/wimax.rst} (74%) rename Documentation/{packing.txt => core-api/packing.rst} (61%) rename Documentation/devicetree/{writing-schema.md => writing-schema.rst} (48%) 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/filesystems/{directory-locking => directory-locking.rst} (86%) rename Documentation/filesystems/{Locking => locking.rst} (79%) rename Documentation/filesystems/nfs/{Exporting => exporting.rst} (91%) rename Documentation/filesystems/{porting => porting.rst} (49%) rename Documentation/filesystems/{ubifs-authentication.md => ubifs-authentication.rst} (95%) rename Documentation/hwmon/{pxe1610 => pxe1610.rst} (82%) rename Documentation/i2c/busses/{i2c-ali1535 => i2c-ali1535.rst} (82%) rename Documentation/i2c/busses/{i2c-ali1563 => i2c-ali1563.rst} (93%) rename Documentation/i2c/busses/{i2c-ali15x3 => i2c-ali15x3.rst} (72%) rename Documentation/i2c/busses/{i2c-amd-mp2 => i2c-amd-mp2.rst} (42%) rename Documentation/i2c/busses/{i2c-amd756 => i2c-amd756.rst} (79%) rename Documentation/i2c/busses/{i2c-amd8111 => i2c-amd8111.rst} (66%) rename Documentation/i2c/busses/{i2c-diolan-u2c => i2c-diolan-u2c.rst} (91%) rename Documentation/i2c/busses/{i2c-i801 => i2c-i801.rst} (89%) rename Documentation/i2c/busses/{i2c-ismt => i2c-ismt.rst} (81%) rename Documentation/i2c/busses/{i2c-mlxcpld => i2c-mlxcpld.rst} (88%) rename Documentation/i2c/busses/{i2c-nforce2 => i2c-nforce2.rst} (58%) rename Documentation/i2c/busses/{i2c-nvidia-gpu => i2c-nvidia-gpu.rst} (63%) rename Documentation/i2c/busses/{i2c-ocores => i2c-ocores.rst} (82%) rename Documentation/i2c/busses/{i2c-parport-light => i2c-parport-light.rst} (91%) rename Documentation/i2c/busses/{i2c-parport => i2c-parport.rst} (49%) rename Documentation/i2c/busses/{i2c-pca-isa => i2c-pca-isa.rst} (72%) rename Documentation/i2c/busses/{i2c-piix4 => i2c-piix4.rst} (92%) rename Documentation/i2c/busses/{i2c-sis5595 => i2c-sis5595.rst} (74%) rename Documentation/i2c/busses/{i2c-sis630 => i2c-sis630.rst} (37%) rename Documentation/i2c/busses/{i2c-sis96x => i2c-sis96x.rst} (74%) rename Documentation/i2c/busses/{i2c-taos-evm => i2c-taos-evm.rst} (91%) rename Documentation/i2c/busses/{i2c-via => i2c-via.rst} (54%) rename Documentation/i2c/busses/{i2c-viapro => i2c-viapro.rst} (87%) create mode 100644 Documentation/i2c/busses/index.rst rename Documentation/i2c/busses/{scx200_acb => scx200_acb.rst} (86%) rename Documentation/i2c/{dev-interface => dev-interface.rst} (71%) rename Documentation/i2c/{DMA-considerations => dma-considerations.rst} (100%) rename Documentation/i2c/{fault-codes => fault-codes.rst} (98%) rename Documentation/i2c/{functionality => functionality.rst} (91%) rename Documentation/i2c/{gpio-fault-injection => gpio-fault-injection.rst} (97%) rename Documentation/i2c/{i2c-protocol => i2c-protocol.rst} (83%) rename Documentation/i2c/{i2c-stub => i2c-stub.rst} (93%) rename Documentation/i2c/{i2c-topology => i2c-topology.rst} (89%) create mode 100644 Documentation/i2c/index.rst rename Documentation/i2c/{instantiating-devices => instantiating-devices.rst} (93%) rename Documentation/i2c/muxes/{i2c-mux-gpio => i2c-mux-gpio.rst} (85%) rename Documentation/i2c/{old-module-parameters => old-module-parameters.rst} (75%) rename Documentation/i2c/{slave-eeprom-backend => slave-eeprom-backend.rst} (90%) rename Documentation/i2c/{slave-interface => slave-interface.rst} (94%) rename Documentation/i2c/{smbus-protocol => smbus-protocol.rst} (82%) rename Documentation/i2c/{summary => summary.rst} (96%) rename Documentation/i2c/{ten-bit-addresses => ten-bit-addresses.rst} (95%) rename Documentation/i2c/{upgrading-clients => upgrading-clients.rst} (54%) rename Documentation/i2c/{writing-clients => writing-clients.rst} (91%) rename Documentation/isdn/{README.avmb1 => avmb1.rst} (50%) rename Documentation/isdn/{CREDITS => credits.rst} (96%) rename Documentation/isdn/{README.gigaset => gigaset.rst} (74%) rename Documentation/isdn/{README.hysdn => hysdn.rst} (80%) create mode 100644 Documentation/isdn/index.rst rename Documentation/isdn/{INTERFACE.CAPI => interface_capi.rst} (75%) rename Documentation/isdn/{README.mISDN => m_isdn.rst} (89%) rename Documentation/m68k/{README.buddha => buddha-driver.rst} (73%) rename Documentation/mips/{AU1xxx_IDE.README => au1xxx_ide.rst} (67%) create mode 100644 Documentation/mips/index.rst rename Documentation/networking/caif/{README => caif.rst} (70%) rename Documentation/networking/mac80211_hwsim/{README => mac80211_hwsim.rst} (81%) rename Documentation/nios2/{README => nios2.rst} (96%) create mode 100644 Documentation/openrisc/index.rst rename Documentation/openrisc/{README => openrisc_port.rst} (80%) rename Documentation/openrisc/{TODO => todo.rst} (78%) rename Documentation/parisc/{debugging => debugging.rst} (94%) create mode 100644 Documentation/parisc/index.rst rename Documentation/parisc/{registers => registers.rst} (70%) rename Documentation/powerpc/{bootwrapper.txt => bootwrapper.rst} (93%) rename Documentation/powerpc/{cpu_families.txt => cpu_families.rst} (95%) rename Documentation/powerpc/{cpu_features.txt => cpu_features.rst} (97%) rename Documentation/powerpc/{cxl.txt => cxl.rst} (95%) rename Documentation/powerpc/{cxlflash.txt => cxlflash.rst} (98%) rename Documentation/powerpc/{DAWR-POWER9.txt => dawr-power9.rst} (95%) rename Documentation/powerpc/{dscr.txt => dscr.rst} (91%) rename Documentation/powerpc/{eeh-pci-error-recovery.txt => eeh-pci-error-recovery.rst} (82%) rename Documentation/powerpc/{firmware-assisted-dump.txt => firmware-assisted-dump.rst} (80%) rename Documentation/powerpc/{hvcs.txt => hvcs.rst} (91%) create mode 100644 Documentation/powerpc/index.rst rename Documentation/powerpc/{mpc52xx.txt => mpc52xx.rst} (91%) rename Documentation/powerpc/{pci_iov_resource_on_powernv.txt => pci_iov_resource_on_powernv.rst} (97%) rename Documentation/powerpc/{pmu-ebb.txt => pmu-ebb.rst} (99%) rename Documentation/powerpc/{ptrace.txt => ptrace.rst} (48%) rename Documentation/powerpc/{qe_firmware.txt => qe_firmware.rst} (95%) rename Documentation/powerpc/{syscall64-abi.txt => syscall64-abi.rst} (82%) rename Documentation/powerpc/{transactional_memory.txt => transactional_memory.rst} (93%) rename Documentation/spi/{butterfly => butterfly.rst} (71%) create mode 100644 Documentation/spi/index.rst rename Documentation/spi/{pxa2xx => pxa2xx.rst} (83%) rename Documentation/spi/{spi-lm70llp => spi-lm70llp.rst} (88%) rename Documentation/spi/{spi-sc18is602 => spi-sc18is602.rst} (92%) rename Documentation/spi/{spi-summary => spi-summary.rst} (93%) rename Documentation/spi/{spidev => spidev.rst} (90%) create mode 100644 Documentation/w1/index.rst rename Documentation/w1/masters/{ds2482 => ds2482.rst} (71%) rename Documentation/w1/masters/{ds2490 => ds2490.rst} (98%) create mode 100644 Documentation/w1/masters/index.rst rename Documentation/w1/masters/{mxc-w1 => mxc-w1.rst} (33%) rename Documentation/w1/masters/{omap-hdq => omap-hdq.rst} (90%) rename Documentation/w1/masters/{w1-gpio => w1-gpio.rst} (75%) create mode 100644 Documentation/w1/slaves/index.rst rename Documentation/w1/slaves/{w1_ds2406 => w1_ds2406.rst} (96%) rename Documentation/w1/slaves/{w1_ds2413 => w1_ds2413.rst} (81%) rename Documentation/w1/slaves/{w1_ds2423 => w1_ds2423.rst} (48%) rename Documentation/w1/slaves/{w1_ds2438 => w1_ds2438.rst} (93%) rename Documentation/w1/slaves/{w1_ds28e04 => w1_ds28e04.rst} (93%) rename Documentation/w1/slaves/{w1_ds28e17 => w1_ds28e17.rst} (88%) rename Documentation/w1/slaves/{w1_therm => w1_therm.rst} (95%) rename Documentation/w1/{w1.generic => w1-generic.rst} (59%) rename Documentation/w1/{w1.netlink => w1-netlink.rst} (77%) -- 2.21.0 ^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH v2 13/26] docs: parisc: convert to ReST and add to documentation body 2019-07-26 12:51 [PATCH v2 00/26] ReST conversion of text files without .txt extension Mauro Carvalho Chehab @ 2019-07-26 12:51 ` Mauro Carvalho Chehab 2019-07-26 13:05 ` [PATCH v2 00/26] ReST conversion of text files without .txt extension Mauro Carvalho Chehab 1 sibling, 0 replies; 3+ messages in thread From: Mauro Carvalho Chehab @ 2019-07-26 12:51 UTC (permalink / raw) Cc: Mauro Carvalho Chehab, Jonathan Corbet, James E.J. Bottomley, Helge Deller, linux-doc, linux-parisc Manually convert the two PA-RISC documents to ReST, adding them to the Linux documentation body. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> --- Documentation/index.rst | 1 + .../parisc/{debugging => debugging.rst} | 7 +++ Documentation/parisc/index.rst | 18 ++++++ .../parisc/{registers => registers.rst} | 59 +++++++++++++------ 4 files changed, 68 insertions(+), 17 deletions(-) rename Documentation/parisc/{debugging => debugging.rst} (94%) create mode 100644 Documentation/parisc/index.rst rename Documentation/parisc/{registers => registers.rst} (70%) diff --git a/Documentation/index.rst b/Documentation/index.rst index d9e607d8a9b9..25e080664050 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -148,6 +148,7 @@ implementation. ia64/index m68k/index powerpc/index + parisc/index riscv/index s390/index sh/index diff --git a/Documentation/parisc/debugging b/Documentation/parisc/debugging.rst similarity index 94% rename from Documentation/parisc/debugging rename to Documentation/parisc/debugging.rst index 7d75223fa18d..de1b60402c5b 100644 --- a/Documentation/parisc/debugging +++ b/Documentation/parisc/debugging.rst @@ -1,8 +1,13 @@ +================= +PA-RISC Debugging +================= + okay, here are some hints for debugging the lower-level parts of linux/parisc. 1. Absolute addresses +===================== A lot of the assembly code currently runs in real mode, which means absolute addresses are used instead of virtual addresses as in the @@ -12,6 +17,7 @@ currently). 2. HPMCs +======== When real-mode code tries to access non-existent memory, you'll get an HPMC instead of a kernel oops. To debug an HPMC, try to find @@ -27,6 +33,7 @@ access it. 3. Q bit fun +============ Certain, very critical code has to clear the Q bit in the PSW. What happens when the Q bit is cleared is the CPU does not update the diff --git a/Documentation/parisc/index.rst b/Documentation/parisc/index.rst new file mode 100644 index 000000000000..aa3ee0470425 --- /dev/null +++ b/Documentation/parisc/index.rst @@ -0,0 +1,18 @@ +.. SPDX-License-Identifier: GPL-2.0 + +==================== +PA-RISC Architecture +==================== + +.. toctree:: + :maxdepth: 2 + + debugging + registers + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex` diff --git a/Documentation/parisc/registers b/Documentation/parisc/registers.rst similarity index 70% rename from Documentation/parisc/registers rename to Documentation/parisc/registers.rst index 10c7d1730f5d..59c8ecf3e856 100644 --- a/Documentation/parisc/registers +++ b/Documentation/parisc/registers.rst @@ -1,11 +1,16 @@ +================================ Register Usage for Linux/PA-RISC +================================ [ an asterisk is used for planned usage which is currently unimplemented ] - General Registers as specified by ABI +General Registers as specified by ABI +===================================== - Control Registers +Control Registers +----------------- +=============================== =============================================== CR 0 (Recovery Counter) used for ptrace CR 1-CR 7(undefined) unused CR 8 (Protection ID) per-process value* @@ -29,26 +34,35 @@ CR28 (TR 4) not used CR29 (TR 5) not used CR30 (TR 6) current / 0 CR31 (TR 7) Temporary register, used in various places +=============================== =============================================== - Space Registers (kernel mode) +Space Registers (kernel mode) +----------------------------- +=============================== =============================================== SR0 temporary space register SR4-SR7 set to 0 SR1 temporary space register SR2 kernel should not clobber this SR3 used for userspace accesses (current process) +=============================== =============================================== - Space Registers (user mode) +Space Registers (user mode) +--------------------------- +=============================== =============================================== SR0 temporary space register SR1 temporary space register SR2 holds space of linux gateway page SR3 holds user address space value while in kernel SR4-SR7 Defines short address space for user/kernel +=============================== =============================================== - Processor Status Word +Processor Status Word +--------------------- +=============================== =============================================== W (64-bit addresses) 0 E (Little-endian) 0 S (Secure Interval Timer) 0 @@ -69,15 +83,19 @@ Q (collect interruption state) 1 (0 in code directly preceding an rfi) P (Protection Identifiers) 1* D (Data address translation) 1, 0 while executing real-mode code I (external interrupt mask) used by cli()/sti() macros +=============================== =============================================== - "Invisible" Registers +"Invisible" Registers +--------------------- +=============================== =============================================== PSW default W value 0 PSW default E value 0 Shadow Registers used by interruption handler code TOC enable bit 1 +=============================== =============================================== -========================================================================= +------------------------------------------------------------------------- The PA-RISC architecture defines 7 registers as "shadow registers". Those are used in RETURN FROM INTERRUPTION AND RESTORE instruction to reduce @@ -85,7 +103,8 @@ the state save and restore time by eliminating the need for general register (GR) saves and restores in interruption handlers. Shadow registers are the GRs 1, 8, 9, 16, 17, 24, and 25. -========================================================================= +------------------------------------------------------------------------- + Register usage notes, originally from John Marvin, with some additional notes from Randolph Chung. @@ -96,10 +115,12 @@ course, you need to save them if you care about them, before calling another procedure. Some of the above registers do have special meanings that you should be aware of: - r1: The addil instruction is hardwired to place its result in r1, + r1: + The addil instruction is hardwired to place its result in r1, so if you use that instruction be aware of that. - r2: This is the return pointer. In general you don't want to + r2: + This is the return pointer. In general you don't want to use this, since you need the pointer to get back to your caller. However, it is grouped with this set of registers since the caller can't rely on the value being the same @@ -107,23 +128,27 @@ that you should be aware of: and return through that register after trashing r2, and that should not cause a problem for the calling routine. - r19-r22: these are generally regarded as temporary registers. + r19-r22: + these are generally regarded as temporary registers. Note that in 64 bit they are arg7-arg4. - r23-r26: these are arg3-arg0, i.e. you can use them if you + r23-r26: + these are arg3-arg0, i.e. you can use them if you don't care about the values that were passed in anymore. - r28,r29: are ret0 and ret1. They are what you pass return values + r28,r29: + are ret0 and ret1. They are what you pass return values in. r28 is the primary return. When returning small structures r29 may also be used to pass data back to the caller. - r30: stack pointer + r30: + stack pointer - r31: the ble instruction puts the return pointer in here. + r31: + the ble instruction puts the return pointer in here. -r3-r18,r27,r30 need to be saved and restored. r3-r18 are just + r3-r18,r27,r30 need to be saved and restored. r3-r18 are just general purpose registers. r27 is the data pointer, and is used to make references to global variables easier. r30 is the stack pointer. - -- 2.21.0 ^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v2 00/26] ReST conversion of text files without .txt extension 2019-07-26 12:51 [PATCH v2 00/26] ReST conversion of text files without .txt extension Mauro Carvalho Chehab 2019-07-26 12:51 ` [PATCH v2 13/26] docs: parisc: convert to ReST and add to documentation body Mauro Carvalho Chehab @ 2019-07-26 13:05 ` Mauro Carvalho Chehab 1 sibling, 0 replies; 3+ messages in thread From: Mauro Carvalho Chehab @ 2019-07-26 13:05 UTC (permalink / raw) To: Jonathan Corbet Cc: linux-doc, linux-kernel, linux-pm, linux-arm-kernel, linux-samsung-soc, linux-pci, linuxppc-dev, linux-scsi, devicetree, linux-i2c, linux-hwmon, linux-spi, linux-iio, linux-rtc, netdev, linux-parisc, openrisc, devel, linux-cifs, samba-technical, devel, dmaengine, alsa-devel, linux-mips, linux-wireless, rcu Em Fri, 26 Jul 2019 09:51:10 -0300 Mauro Carvalho Chehab <mchehab+samsung@kernel.org> escreveu: > This series converts the text files under Documentation with doesn't end > neither .txt or .rst and are not part of ABI or features. > > This series is at: > https://git.linuxtv.org/mchehab/experimental.git/log/?h=rst_for_5_4_v3 > > And it is based on yesterday's upstream tree. > > After this series, we have ~320 files left to be converted to ReST. > > v2: > - Added 3 files submitted for v5.3 that weren't merged yet; > - markdown patch broken into two, per Rob's request; > - rebased on the top of upstream master branch > > Mauro Carvalho Chehab (26): > docs: ABI: remove extension from sysfs-class-mic.txt ^ In time: this one was already merged. Thanks, Mauro ^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2019-07-26 13:05 UTC | newest] Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2019-07-26 12:51 [PATCH v2 00/26] ReST conversion of text files without .txt extension Mauro Carvalho Chehab 2019-07-26 12:51 ` [PATCH v2 13/26] docs: parisc: convert to ReST and add to documentation body Mauro Carvalho Chehab 2019-07-26 13:05 ` [PATCH v2 00/26] ReST conversion of text files without .txt extension Mauro Carvalho Chehab
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).