]> asedeno.scripts.mit.edu Git - linux.git/commitdiff
docs: blockdev: add it to the admin-guide
authorMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Tue, 18 Jun 2019 14:47:10 +0000 (11:47 -0300)
committerMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Mon, 15 Jul 2019 14:03:01 +0000 (11:03 -0300)
The blockdev book basically contains user-faced documentation.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
22 files changed:
Documentation/admin-guide/blockdev/drbd/DRBD-8.3-data-packets.svg [moved from Documentation/blockdev/drbd/DRBD-8.3-data-packets.svg with 100% similarity]
Documentation/admin-guide/blockdev/drbd/DRBD-data-packets.svg [moved from Documentation/blockdev/drbd/DRBD-data-packets.svg with 100% similarity]
Documentation/admin-guide/blockdev/drbd/conn-states-8.dot [moved from Documentation/blockdev/drbd/conn-states-8.dot with 100% similarity]
Documentation/admin-guide/blockdev/drbd/data-structure-v9.rst [moved from Documentation/blockdev/drbd/data-structure-v9.rst with 100% similarity]
Documentation/admin-guide/blockdev/drbd/disk-states-8.dot [moved from Documentation/blockdev/drbd/disk-states-8.dot with 100% similarity]
Documentation/admin-guide/blockdev/drbd/drbd-connection-state-overview.dot [moved from Documentation/blockdev/drbd/drbd-connection-state-overview.dot with 100% similarity]
Documentation/admin-guide/blockdev/drbd/figures.rst [moved from Documentation/blockdev/drbd/figures.rst with 100% similarity]
Documentation/admin-guide/blockdev/drbd/index.rst [moved from Documentation/blockdev/drbd/index.rst with 100% similarity]
Documentation/admin-guide/blockdev/drbd/node-states-8.dot [moved from Documentation/blockdev/drbd/node-states-8.dot with 99% similarity]
Documentation/admin-guide/blockdev/floppy.rst [moved from Documentation/blockdev/floppy.rst with 100% similarity]
Documentation/admin-guide/blockdev/index.rst [moved from Documentation/blockdev/index.rst with 94% similarity]
Documentation/admin-guide/blockdev/nbd.rst [moved from Documentation/blockdev/nbd.rst with 100% similarity]
Documentation/admin-guide/blockdev/paride.rst [moved from Documentation/blockdev/paride.rst with 100% similarity]
Documentation/admin-guide/blockdev/ramdisk.rst [moved from Documentation/blockdev/ramdisk.rst with 100% similarity]
Documentation/admin-guide/blockdev/zram.rst [moved from Documentation/blockdev/zram.rst with 100% similarity]
Documentation/admin-guide/index.rst
Documentation/admin-guide/kernel-parameters.txt
MAINTAINERS
drivers/block/Kconfig
drivers/block/floppy.c
drivers/block/zram/Kconfig
tools/testing/selftests/zram/README

similarity index 99%
rename from Documentation/blockdev/drbd/node-states-8.dot
rename to Documentation/admin-guide/blockdev/drbd/node-states-8.dot
index 4a2b00c235471dcd9b150a7b2beceaa9760b9779..bfa54e1f8016a183df30fe2523f77848eaf4d2eb 100644 (file)
@@ -11,4 +11,3 @@ digraph peer_states {
        Unknown   -> Primary           [ label = "connected" ]
        Unknown   -> Secondary         [ label = "connected" ]
 }
-
similarity index 94%
rename from Documentation/blockdev/index.rst
rename to Documentation/admin-guide/blockdev/index.rst
index a9af6ed8b4aa40c194a1d4de9856c30743e75c68..20a738d9d047cbe4a97edebee7090c6d5e46a2c2 100644 (file)
@@ -1,5 +1,3 @@
-:orphan:
-
 ===========================
 The Linux RapidIO Subsystem
 ===========================
index 5b63182ceb5f0d49ca8a2d71baedc1acead6fab9..9228fbf5ce4ee375550cb362755a500ddb88ac17 100644 (file)
@@ -73,6 +73,7 @@ configure specific aspects of kernel behavior to your liking.
    java
    ras
    bcache
+   blockdev/index
    ext4
    binderfs
    pm/index
index e645b3ab4b6f1de5881d4d26daa17fa143ed7860..78576aa45cce1c6295c95097245fc8fb2c3b8622 100644 (file)
                        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
        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: <integer>
 
        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.
 
                        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.
                        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.
 
        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.
        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
                        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
index b36028f431925422fbe96ef3d156ad6654afe93b..699596d931c19d970bf2be162b2bf4a614e381d1 100644 (file)
@@ -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 <gregkh@linuxfoundation.org>
@@ -11076,7 +11076,7 @@ M:      Josef Bacik <josef@toxicpanda.com>
 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 <tim@cyberelk.net>
 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 <axboe@kernel.dk>
 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 <sergey.senozhatsky.work@gmail.com>
 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" <macro@linux-mips.org>
index c43690b973d81ca3f5a7b5d7f6dd6ea3f432c303..1bb8ec5753527173696333dd67cd6998448f90cc 100644 (file)
@@ -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
-         <file:Documentation/blockdev/floppy.rst>.
+         <file:Documentation/admin-guide/blockdev/floppy.rst>.
          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 <file:Documentation/blockdev/paride.rst> for more information.
+         Read <file:Documentation/admin-guide/blockdev/paride.rst> 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 <file:Documentation/blockdev/nbd.rst> for more information,
+         Read <file:Documentation/admin-guide/blockdev/nbd.rst> 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 <file:Documentation/blockdev/ramdisk.rst>.
+         For details, read <file:Documentation/admin-guide/blockdev/ramdisk.rst>.
 
          To compile this driver as a module, choose M here: the
          module will be called brd. An alias "rd" has been defined
index 5c99e52f9dc15f03189770d889f627fac534bf9e..f652c1ac3ae987ae103445620f0f24345f157241 100644 (file)
@@ -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;
 }
 
index e06b99d54816f691b1bb966116516e39fc39c7db..fe7a4b7d30cfe3076d4e8fffbfee51d290366720 100644 (file)
@@ -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.
index 5fa378391d3b44142ab51b35004f94aa3cdf4f49..110b34834a6fa03a95a0c4bb362ec15ff7f15302 100644 (file)
@@ -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