From e7751617dd0599ceadf4221cb08e04307b00aa1f Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Tue, 18 Jun 2019 11:47:10 -0300 Subject: [PATCH] docs: blockdev: add it to the admin-guide The blockdev book basically contains user-faced documentation. Signed-off-by: Mauro Carvalho Chehab --- .../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 | 0 .../{ => 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 Documentation/admin-guide/index.rst | 1 + .../admin-guide/kernel-parameters.txt | 18 +++++++++--------- MAINTAINERS | 10 +++++----- drivers/block/Kconfig | 8 ++++---- drivers/block/floppy.c | 2 +- drivers/block/zram/Kconfig | 6 +++--- tools/testing/selftests/zram/README | 2 +- 22 files changed, 24 insertions(+), 26 deletions(-) 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 (100%) 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 (94%) 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%) diff --git a/Documentation/blockdev/drbd/DRBD-8.3-data-packets.svg b/Documentation/admin-guide/blockdev/drbd/DRBD-8.3-data-packets.svg similarity index 100% rename from Documentation/blockdev/drbd/DRBD-8.3-data-packets.svg rename to Documentation/admin-guide/blockdev/drbd/DRBD-8.3-data-packets.svg diff --git a/Documentation/blockdev/drbd/DRBD-data-packets.svg b/Documentation/admin-guide/blockdev/drbd/DRBD-data-packets.svg similarity index 100% rename from Documentation/blockdev/drbd/DRBD-data-packets.svg rename to Documentation/admin-guide/blockdev/drbd/DRBD-data-packets.svg diff --git a/Documentation/blockdev/drbd/conn-states-8.dot b/Documentation/admin-guide/blockdev/drbd/conn-states-8.dot similarity index 100% rename from Documentation/blockdev/drbd/conn-states-8.dot rename to Documentation/admin-guide/blockdev/drbd/conn-states-8.dot diff --git a/Documentation/blockdev/drbd/data-structure-v9.rst b/Documentation/admin-guide/blockdev/drbd/data-structure-v9.rst similarity index 100% rename from Documentation/blockdev/drbd/data-structure-v9.rst rename to Documentation/admin-guide/blockdev/drbd/data-structure-v9.rst diff --git a/Documentation/blockdev/drbd/disk-states-8.dot b/Documentation/admin-guide/blockdev/drbd/disk-states-8.dot similarity index 100% rename from Documentation/blockdev/drbd/disk-states-8.dot rename to Documentation/admin-guide/blockdev/drbd/disk-states-8.dot diff --git a/Documentation/blockdev/drbd/drbd-connection-state-overview.dot b/Documentation/admin-guide/blockdev/drbd/drbd-connection-state-overview.dot similarity index 100% rename from Documentation/blockdev/drbd/drbd-connection-state-overview.dot rename to Documentation/admin-guide/blockdev/drbd/drbd-connection-state-overview.dot diff --git a/Documentation/blockdev/drbd/figures.rst b/Documentation/admin-guide/blockdev/drbd/figures.rst similarity index 100% rename from Documentation/blockdev/drbd/figures.rst rename to Documentation/admin-guide/blockdev/drbd/figures.rst diff --git a/Documentation/blockdev/drbd/index.rst b/Documentation/admin-guide/blockdev/drbd/index.rst similarity index 100% rename from Documentation/blockdev/drbd/index.rst rename to Documentation/admin-guide/blockdev/drbd/index.rst diff --git a/Documentation/blockdev/drbd/node-states-8.dot b/Documentation/admin-guide/blockdev/drbd/node-states-8.dot similarity index 99% rename from Documentation/blockdev/drbd/node-states-8.dot rename to Documentation/admin-guide/blockdev/drbd/node-states-8.dot index 4a2b00c23547..bfa54e1f8016 100644 --- a/Documentation/blockdev/drbd/node-states-8.dot +++ b/Documentation/admin-guide/blockdev/drbd/node-states-8.dot @@ -11,4 +11,3 @@ digraph peer_states { Unknown -> Primary [ label = "connected" ] Unknown -> Secondary [ label = "connected" ] } - diff --git a/Documentation/blockdev/floppy.rst b/Documentation/admin-guide/blockdev/floppy.rst similarity index 100% rename from Documentation/blockdev/floppy.rst rename to Documentation/admin-guide/blockdev/floppy.rst diff --git a/Documentation/blockdev/index.rst b/Documentation/admin-guide/blockdev/index.rst similarity index 94% rename from Documentation/blockdev/index.rst rename to Documentation/admin-guide/blockdev/index.rst index a9af6ed8b4aa..20a738d9d047 100644 --- a/Documentation/blockdev/index.rst +++ b/Documentation/admin-guide/blockdev/index.rst @@ -1,5 +1,3 @@ -:orphan: - =========================== The Linux RapidIO Subsystem =========================== diff --git a/Documentation/blockdev/nbd.rst b/Documentation/admin-guide/blockdev/nbd.rst similarity index 100% rename from Documentation/blockdev/nbd.rst rename to Documentation/admin-guide/blockdev/nbd.rst diff --git a/Documentation/blockdev/paride.rst b/Documentation/admin-guide/blockdev/paride.rst similarity index 100% rename from Documentation/blockdev/paride.rst rename to Documentation/admin-guide/blockdev/paride.rst diff --git a/Documentation/blockdev/ramdisk.rst b/Documentation/admin-guide/blockdev/ramdisk.rst similarity index 100% rename from Documentation/blockdev/ramdisk.rst rename to Documentation/admin-guide/blockdev/ramdisk.rst diff --git a/Documentation/blockdev/zram.rst b/Documentation/admin-guide/blockdev/zram.rst similarity index 100% rename from Documentation/blockdev/zram.rst rename to Documentation/admin-guide/blockdev/zram.rst diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst index 5b63182ceb5f..9228fbf5ce4e 100644 --- a/Documentation/admin-guide/index.rst +++ b/Documentation/admin-guide/index.rst @@ -73,6 +73,7 @@ configure specific aspects of kernel behavior to your liking. java ras bcache + blockdev/index ext4 binderfs pm/index diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt index e645b3ab4b6f..78576aa45cce 100644 --- a/Documentation/admin-guide/kernel-parameters.txt +++ b/Documentation/admin-guide/kernel-parameters.txt @@ -1249,7 +1249,7 @@ See also Documentation/fault-injection/. floppy= [HW] - See Documentation/blockdev/floppy.rst. + See Documentation/admin-guide/blockdev/floppy.rst. force_pal_cache_flush [IA-64] Avoid check_sal_cache_flush which may hang on @@ -2234,7 +2234,7 @@ memblock=debug [KNL] Enable memblock debug messages. load_ramdisk= [RAM] List of ramdisks to load from floppy - See Documentation/blockdev/ramdisk.rst. + See Documentation/admin-guide/blockdev/ramdisk.rst. lockd.nlm_grace_period=P [NFS] Assign grace period. Format: @@ -3268,7 +3268,7 @@ pcd. [PARIDE] See header of drivers/block/paride/pcd.c. - See also Documentation/blockdev/paride.rst. + See also Documentation/admin-guide/blockdev/paride.rst. pci=option[,option...] [PCI] various PCI subsystem options. @@ -3512,7 +3512,7 @@ needed on a platform with proper driver support. pd. [PARIDE] - See Documentation/blockdev/paride.rst. + See Documentation/admin-guide/blockdev/paride.rst. pdcchassis= [PARISC,HW] Disable/Enable PDC Chassis Status codes at boot time. @@ -3527,10 +3527,10 @@ and performance comparison. pf. [PARIDE] - See Documentation/blockdev/paride.rst. + See Documentation/admin-guide/blockdev/paride.rst. pg. [PARIDE] - See Documentation/blockdev/paride.rst. + See Documentation/admin-guide/blockdev/paride.rst. pirq= [SMP,APIC] Manual mp-table setup See Documentation/x86/i386/IO-APIC.rst. @@ -3642,7 +3642,7 @@ prompt_ramdisk= [RAM] List of RAM disks to prompt for floppy disk before loading. - See Documentation/blockdev/ramdisk.rst. + See Documentation/admin-guide/blockdev/ramdisk.rst. psi= [KNL] Enable or disable pressure stall information tracking. @@ -3664,7 +3664,7 @@ pstore.backend= Specify the name of the pstore backend to use pt. [PARIDE] - See Documentation/blockdev/paride.rst. + See Documentation/admin-guide/blockdev/paride.rst. pti= [X86_64] Control Page Table Isolation of user and kernel address spaces. Disabling this feature @@ -3693,7 +3693,7 @@ See Documentation/admin-guide/md.rst. ramdisk_size= [RAM] Sizes of RAM disks in kilobytes - See Documentation/blockdev/ramdisk.rst. + See Documentation/admin-guide/blockdev/ramdisk.rst. random.trust_cpu={on,off} [KNL] Enable or disable trusting the use of the diff --git a/MAINTAINERS b/MAINTAINERS index b36028f43192..699596d931c1 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -5006,7 +5006,7 @@ T: git git://git.linbit.com/drbd-8.4.git S: Supported F: drivers/block/drbd/ F: lib/lru_cache.c -F: Documentation/blockdev/drbd/ +F: Documentation/admin-guide/blockdev/ DRIVER CORE, KOBJECTS, DEBUGFS AND SYSFS M: Greg Kroah-Hartman @@ -11076,7 +11076,7 @@ M: Josef Bacik S: Maintained L: linux-block@vger.kernel.org L: nbd@other.debian.org -F: Documentation/blockdev/nbd.rst +F: Documentation/admin-guide/blockdev/nbd.rst F: drivers/block/nbd.c F: include/trace/events/nbd.h F: include/uapi/linux/nbd.h @@ -12086,7 +12086,7 @@ PARIDE DRIVERS FOR PARALLEL PORT IDE DEVICES M: Tim Waugh L: linux-parport@lists.infradead.org (subscribers-only) S: Maintained -F: Documentation/blockdev/paride.rst +F: Documentation/admin-guide/blockdev/paride.rst F: drivers/block/paride/ PARISC ARCHITECTURE @@ -13367,7 +13367,7 @@ F: drivers/net/wireless/ralink/rt2x00/ RAMDISK RAM BLOCK DEVICE DRIVER M: Jens Axboe S: Maintained -F: Documentation/blockdev/ramdisk.rst +F: Documentation/admin-guide/blockdev/ramdisk.rst F: drivers/block/brd.c RANCHU VIRTUAL BOARD FOR MIPS @@ -17723,7 +17723,7 @@ R: Sergey Senozhatsky L: linux-kernel@vger.kernel.org S: Maintained F: drivers/block/zram/ -F: Documentation/blockdev/zram.rst +F: Documentation/admin-guide/blockdev/zram.rst ZS DECSTATION Z85C30 SERIAL DRIVER M: "Maciej W. Rozycki" diff --git a/drivers/block/Kconfig b/drivers/block/Kconfig index c43690b973d8..1bb8ec575352 100644 --- a/drivers/block/Kconfig +++ b/drivers/block/Kconfig @@ -31,7 +31,7 @@ config BLK_DEV_FD If you want to use the floppy disk drive(s) of your PC under Linux, say Y. Information about this driver, especially important for IBM Thinkpad users, is contained in - . + . That file also contains the location of the Floppy driver FAQ as well as location of the fdutils package used to configure additional parameters of the driver at run time. @@ -96,7 +96,7 @@ config PARIDE your computer's parallel port. Most of them are actually IDE devices using a parallel port IDE adapter. This option enables the PARIDE subsystem which contains drivers for many of these external drives. - Read for more information. + Read for more information. If you have said Y to the "Parallel-port support" configuration option, you may share a single port between your printer and other @@ -261,7 +261,7 @@ config BLK_DEV_NBD userland (making server and client physically the same computer, communicating using the loopback network device). - Read for more information, + Read for more information, especially about where to find the server code, which runs in user space and does not need special kernel support. @@ -303,7 +303,7 @@ config BLK_DEV_RAM during the initial install of Linux. Note that the kernel command line option "ramdisk=XX" is now obsolete. - For details, read . + For details, read . To compile this driver as a module, choose M here: the module will be called brd. An alias "rd" has been defined diff --git a/drivers/block/floppy.c b/drivers/block/floppy.c index 5c99e52f9dc1..f652c1ac3ae9 100644 --- a/drivers/block/floppy.c +++ b/drivers/block/floppy.c @@ -4424,7 +4424,7 @@ static int __init floppy_setup(char *str) pr_cont("\n"); } else DPRINT("botched floppy option\n"); - DPRINT("Read Documentation/blockdev/floppy.rst\n"); + DPRINT("Read Documentation/admin-guide/blockdev/floppy.rst\n"); return 0; } diff --git a/drivers/block/zram/Kconfig b/drivers/block/zram/Kconfig index e06b99d54816..fe7a4b7d30cf 100644 --- a/drivers/block/zram/Kconfig +++ b/drivers/block/zram/Kconfig @@ -12,7 +12,7 @@ config ZRAM It has several use cases, for example: /tmp storage, use as swap disks and maybe many more. - See Documentation/blockdev/zram.rst for more information. + See Documentation/admin-guide/blockdev/zram.rst for more information. config ZRAM_WRITEBACK bool "Write back incompressible or idle page to backing device" @@ -26,7 +26,7 @@ config ZRAM_WRITEBACK With /sys/block/zramX/{idle,writeback}, application could ask idle page's writeback to the backing device to save in memory. - See Documentation/blockdev/zram.rst for more information. + See Documentation/admin-guide/blockdev/zram.rst for more information. config ZRAM_MEMORY_TRACKING bool "Track zRam block status" @@ -36,4 +36,4 @@ config ZRAM_MEMORY_TRACKING of zRAM. Admin could see the information via /sys/kernel/debug/zram/zramX/block_state. - See Documentation/blockdev/zram.rst for more information. + See Documentation/admin-guide/blockdev/zram.rst for more information. diff --git a/tools/testing/selftests/zram/README b/tools/testing/selftests/zram/README index 5fa378391d3b..110b34834a6f 100644 --- a/tools/testing/selftests/zram/README +++ b/tools/testing/selftests/zram/README @@ -37,4 +37,4 @@ Commands required for testing: - mkfs/ mkfs.ext4 For more information please refer: -kernel-source-tree/Documentation/blockdev/zram.rst +kernel-source-tree/Documentation/admin-guide/blockdev/zram.rst